SESSION Object

Software Customisation Reference Manual

Summary of Objects, Members and Methods : Object Type Details : SESSION Object


Name	Type	Purpose
UniqueID	STRING Get/Set	Internal ID
Name	STRING Get/Set	Session Name
Login	STRING Get/Set	User’s login ID
Host	STRING Get/Set	ID of the Machine running the session
Entered	STRING Get/Set	Time of entering the session
LocationName	STRING Get/Set	Name of Location for Session
IsRemote	STRING Get/Set	True for Sessions at Remote locations
IsCurrent	BOOLEAN Get/Set	TRUE for User’s own SESSION object

Methods


Name	Result	Purpose
SESSION (STRING)	SESSION	Returns a SESSION object, given a string containing a session's Unique-id.
ConfirmID (STRING)	BOOLEAN	Returns TRUE if the password specified by the STRING is correct for the currently logged-in user. (The STRING value must include the leading ‘/’ character).
Current()	ARRAY OF DB	List of Current DBs in the MDB of the SESSION object.
Deferred()	ARRAY OF DB	List Deferred DB’s in the MDB of the SESSION object.
Location()	LOCATION	Return LOCATION to which the Session applies. In a non-Global project, returns NULL or error.
MDB()	MDB	The current MDB of the SESSION.
Mode()	ARRAY OF STRING	List of potential access modes as ‘R’ , ‘RW’ or ‘N’ for each of the current DBs.
Modified()	BOOLEAN	TRUE if database has been modified.
Module()	STRING	Name of the current module.
Status()	ARRAY OF STRINGS	List of current access modes as ‘R’ , ‘RW’ or ‘N’ for each of the current DBs.
User()	USER	you of this SESSION object.

Note:

•

The LocationName member and Location() method imply the location to which the Session applies. This is normally the current location, except when Sessions at remote locations have been requested. In a non-Global project, these members and methods may be unavailable or unset.

•

Some ADMIN Sessions in a Global project may apply to another location's system database. This will be returned as part of the string returned by the Module() method, if relevant. Other ADMIN Sessions may actually be Global Daemon Sessions. This is returned as part of the string for the name member.

•

Some SESSION object methods have only restricted availability:

•

The Modified() method only applies to the current Session at the current location.

•

The Current(), Deferred(), Mode() and Status() methods will not be implemented for remote Sessions and will return an error.

•

The Location(), MDB(), User() and Module() methods are valid for remote Sessions.

The last three methods will cause Daemon activity for Sessions at remote locations.

•

It should be should be observed in using the MDB and USER objects returned by the MDB() and User() methods for a remote Session. Methods on these objects will access the currently open system database. Thus the appropriate location's system database should be opened (using the ADMINISTER SYSTEM command) before invoking methods on these remotely generated MDB and USER objects.

Command


!SESSION = CURRENT SESSION	$ Returns the current session object.