JCONNECTION.OBJECT

Man Page Index



The jConnection Object represents a connection to a specific machine on the network.

CALL METHOD



Calls a cataloged jBC subroutine.

SYNTAX



jConnectionObject.Call subroutine, parameters.

Part Description

subroutine The name of a catalogued jBC subroutine.
parameters Up to 20 comma separated parameters to the called
subroutine.

REMARKS



The number of parameters specified must match the number of parameters
expected by the called routine.

Parameters

The number of parameters specified must match the number of parameters
expected by the called routine.
All parameters are passed by reference and can by modified by the jBC
subroutine unless they are explicitly passed by value by the caller.
To pass by value in Visual Basic, enclosing the parameter in parentheses
will create a temporary variable to hold the result of the expression in
parentheses.
Parameters can be any of the valid OLE types including references to
objects. OBjEX will perform the necessary conversions between OLE and
jBC variable types.



CREATEFILE METHOD



Creates a new file.

SYNTAX



Object.CreateFile filename,options

Part Description

Object The jBase Object or a jConnection Object.
jBaseobject A variable of jBase object data type that represents the
jBase object.
filename A string expression that is the name of a file and may
include the path to the file.
options An optional string expression that supplies any desired modifiers
to the file create processor. See jBase documentation for details.

DATE PROPERTY



Returns the current date in jBase internal format.

SYNTAX



Object.Date()

REMARKS



The date is returned as an integer containing the number of days since
December 31 1967.

DELETELIST METHOD



Deletes a previously stored list.

SYNTAX



jConnectionObject.DeleteList Name

Part Description

Name A string expression that evaluates to the name of the list to be
deleted.

REMARKS



Lists are saved in the jBase work file.


EXECUTE METHOD



Executes any other program from the command line.

SYNTAX



jConnectionObject.Execute
CommandLine,Options,[,Setting[,Capturing[,RtnList[,PassList]]]]

Part Description

CommandLine A string expression that evaluates to the command to be
executed
Options A numeric expression available for future options - Use
zero for now.
Setting A variable that will capture the output of any error messages
generated by the command
Capturing A variable that will capture the terminal output generated
by the command.
RtnList A variable that will reference a jSelectList Object created
by the command.
PassList The name of a jSelectListobject to pass to the command.

GETLIST METHOD



Retrieves a previously stored list.

SYNTAX



Set jSelectList object = jConnectionObject.GetList( Name)

Part Description

Name A string expression that evaluates to the name of the list to be
retrieved.
jSelectList object A variable of jSelectList data type that will be set
up to reference the retrieved select list.

REMARKS



Lists are saved in the jBase work file.


ICONV METHOD



Applies a jBase input conversion code to the supplied data.

SYNTAX



destvar = Object.IConv( sourcevar, convcode )

Part Description

destvar The name of a Variant that receives the data from the
Conversion.
Object The jBase Object or a jConnection Object.
sourcevar A variant that contains the data to be converted.
Convcode A string expression that evaluates to the desired conversion
code.

NOTES



For a list of available conversion codes, see OConv Method for jBASE
OBJECT.

OConv Method

Applies a jBase conversion code to the supplied data.

SYNTAX



destvar = Object.OConv( sourcevar, convcode )

See Oconv Method for jBASE OBJECT

Open Method

Opens a specific file and, if successful, returns a reference to it.

SYNTAX



Set jEDIobject = Object.Open(filename)

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
that you are opening.
Object The jBase Object or a jConnection Object.
filename A string expression that is the name of a file and may
include the path to the file.


PRECISION PROPERTY



Returns or sets the current precision used for the Call method

SYNTAX



precision =jConnectionObject.Precision()
jConnectionObject.Precision = precision

REMARKS



The precision is an integer between zero and nine. The default is four.

TIME PROPERTY



Returns the current time in jBase internal format.

SYNTAX



Object.Time()

REMARKS



The time is returned as an integer containing the number of seconds since
midnight.



JEDI OBJECT



The jEDI Object represents an open file.

jEDI Objects are created by using the Open method of the jConnection
object

They are closed when all references to them have been deleted.

METHODS



CLEARFILE METHOD



Deletes all records from the file.

SYNTAX



jEDIobject.ClearFile

Part Description

jEDIobject A variable of a jEDI object data type. This represents the
file to which you are referring.

Copy Method

Creates a copy of an object.

SYNTAX



Set NewObject = Object.Copy()

Part Description

NewObject A variable to receive a reference to the newly created
object.
Object A reference to the object to be copied.


NOTES



jEDI objects are handles to open files. Copying the jEDI object creates a
new handle to the same file.


DELETE METHOD



Deletes specific record from a file.

SYNTAX



jEDIobject.Delete(recordKey)

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
that you are deleting from.
recordkey A string expression that is the name of the record to be
deleted.

REMARKS



If the record cannot be deleted then an error status is returned.

READ METHOD



Reads a specific record from a file into a new jDynArray object.

SYNTAX



Set jDynArrayobject = jEDIobject.Read(recordkey)

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
that you are opening.
jDynArrayobject A variable of jDynArray type that will be receive a
reference to the resulting jDynArray object.
recordkey A string expression that is the name of the record to be
read.

REMARKS



If the record cannot be read then an error status is returned.


READU METHOD



Reads a specific record from a file into a new jDynArray object. If
successful, the record is locked.

SYNTAX



Set jDynArrayobject = jEDIobject.ReadU(recordkey)

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
that you are opening.
jDynArrayobject A variable of jDynArray type that will be receive a
reference to the resultant jDynArray object.
recordkey A string expression that is the name of the record to be
read.

REMARKS



If the record cannot be read then an error status is returned.


READV METHOD



Reads a specific field from a file into a variable.

SYNTAX



destvar = jEDIobject.ReadV(recordkey, field number)

Part Description

destvar A variable of type VARIANT.
jEDIobject A variable of a jEDI object data type that represents the file
that you are opening.
recordkey A string expression that is the name of the record to be
read.
field number A numeric expression that is the field number you want to
read.

REMARKS



If the record cannot be read then an error status is returned.



READVU METHOD



Reads a specific field from a file into a variable. If successful, the record is
locked.

SYNTAX



destvar = jEDIobject.ReadVU(recordkey, field number)

Part Description

destvar A variable of type VARIANT.
jEDIobject A variable of a jEDI object data type that represents the file
that you are opening.
recordkey A string expression that is the name of the record to be
read.
field number A numeric expression that is the field number you want to
read.

REMARKS



If the record cannot be read then an error status is returned.

ReleaseAllLocks

Release all locks on records in a file.

SYNTAX



jEDIobject.ReleaseAllLocks()

Part Description

jEDIobject A variable of a jEDI object data type that represents the
file.

RELEASELOCK METHOD



Release the lock on a specific record in a file.

SYNTAX



jEDIobject.ReleaseLock(recordkey)

Part Description

jEDIobject A variable of a jEDI object data type that represents the
file.
recordkey A string expression that is the name of the record to be
unlocked.


SELECT METHOD



Returns a jSelectList object that represents all the record keys in the file.

SYNTAX



Set jSelectList object = jEDIobject.Select()
Set jSelectList object = jDynArrayobject.Select()

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
that you are opening.
jSelectList object A variable of jSelectList data type that will be set
up to reference the created select list.

WRITE METHOD



Write a jDynArray object into a file, releasing any locks held on the
record.

SYNTAX



jEDIobject.Write recordkey, jDynArrayobject

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
to which you are writing.
jDynArrayobject A variable of jDynArray data type that will be
written to the file.
recordkey A string expression that is the name of the record to be
written.

REMARKS



If the record cannot be written then an error status is returned.


WRITEU METHOD



Write a jDynArray object into a file retaining any locks on the record.

SYNTAX



jEDIobject.WriteU recordkey, jDynArrayobject

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
to which you are writing.
jDynArrayobject A variable of jDynArray data type that will be
written to the file.
recordkey A string expression that is the name of the record to be
written.

REMARKS



If the record cannot be written then an error status is returned.

WRITEV METHOD



Update a specific field in a record, releasing any locks held on the record.

SYNTAX



jEDIobject.WriteV recordkey, fieldnumber, replacementvalue

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
that you are updating.
recordkey A string expression that is the name of the record to be
updated.
fieldnumber A numeric expression that specifies the field to be updated.
replacementvalue An expression that is the value to replace the
specified field.

REMARKS



If the record cannot be read or written then an error status is returned.


WRITEVU METHOD



Update a specific field in a file, retaining any locks held on the record.

SYNTAX



jEDIobject.WriteVU recordkey, fieldnumber, Replacement Value

Part Description

jEDIobject A variable of a jEDI object data type that represents the file
that you are updating.
recordkey A string expression that is the name of the record to be
updated.
fieldnumber A numeric expression that specifies the field to be updated.
Replacement Value An expression that is the value to replace the
specified field.

REMARKS



If the record cannot be read or written then an error status is returned.

OBJEX
Copyright (c) 1999 TEMENOS HOLDINGS NV. All rights reserved.