3. System Classes : ButtonField Class : SessionObject Class
 
Share this page                  
SessionObject Class
SessionObject Attributes
Attribute
Data Type
Description
Inherited
From
AppFlags
array of AppFlag
Specifies the parameters and flags for the application (R)
Defined
CallSystemStatus
integer
Contains the exit status code of the process executed by the last call system statement (R)
Defined
ClassName
varchar(32)
Gives the name of an object's actual type (as opposed to its declared type) (R)
Object
ClientData
Object
Provides a way to associate data with an object (RW)
Object
DBEventPollrate
integer
Specifies how often, in seconds, the application polls for database events (RW)
Defined
DBMSErrorPrinting
smallint
Specifies how to print error messages (RW)
Defined
DBMSMessagePrinting
integer
Defines how to display messages sent by a database procedure message statement (RW)
Defined
DisplayCapability
integer
Indicates whether the display being used is color or black and white (R)
Defined
ExitCode
integer
Indicates whether the OpenROAD program exited as usual. Value is returned to the operating system. (RW)
Defined
ExternalError
integer
Stores the completion status of the last ActiveX operation as a Microsoft HRESULT type (R)
Defined
InstanceIdentifier
integer
Contains a value that uniquely identifies an instance of an allocated object (R)
Object
InstanceReferences
integer
Contains the current number of references to the object (R)
Object
OperatingSystem
integer
Specifies which operating system is currently in use (R)
Defined
PixelScreenHeight
integer
Specifies screen height in pixels (R)
Defined
PixelScreenWidth
integer
Specifies screen width in pixels (R)
Defined
ProcessWait
integer
Specifies whether commands executed by the call system statement block the execution of the currently running OpenROAD application until they complete (RW)
Defined
ProcessWindow
integer
Specifies whether commands executed by the call system statement run in a process that has a window (RW)
Defined
Runtime
integer
Returns the OpenROAD runtime mode (R)
Defined
Scope
Scope
Specifies the Scope object associated with the currently running application (R)
Defined
ScreenHeight
integer
Specifies screen height in units of 1000ths of an inch (R)
Defined
ScreenWidth
integer
Specifies screen width in units of 1000ths of an inch (R)
Defined
TimeZone
string
Sets or retrieves the current Ingres Timezone name (RW)
Defined
UserName
varchar(256)
Specifies the user name of the current user (R)
Defined
Version
varchar(256)
Specifies the OpenROAD version number under which the application is running (R)
Defined
WindowSystem
integer
Specifies which window management system is currently in use (R)
Defined
 
SessionObject Methods
Method
Return
Value
Description
Inherited From
CheckFeature
(feature =
integer)
integer
Checks at what level a specified feature is supported
Defined
ClearErrorFlag ()
none
Allows the application to reset the error flag so that the application server will not know that there was an error
Defined
CreateDirectory
(directory
= varchar(256))
integer
Creates a directory and returns TRUE for success
Defined
DirectoryExists
(directory
= varchar(256))
integer
Determines whether a directory exists
Defined
Duplicate()
SessionObject
Makes a duplicate of the object, placing a reference to the new object in a reference variable
Object
FileExists
(filename =
varchar(256))
integer
Determines whether a specified file exists
Defined
GenerateGUID()
string
Returns a string that represents a unique GUID
Defined
GetAttribute
(
attributename = byref(variable)
{,attributename = byref(variable)})
integer
Gets the values of any number of attributes for the object
Object
GetColorName
(index =
integer)
varchar(256)
Obtains the name of the color represented by a particular index
Defined
GetEnv
(name
= varchar(256))
varchar
Returns the current setting of a specified environment variable in the user's environment
Defined
IsA
(class =
classname)
integer
Returns TRUE if the object is of the same class as, or one of the subclasses of, the class specified by classname
Object
SetAttribute
(
attributename = value
{,attributename = value})
integer
Sets any number of attributes for the object
Object
SetEnv(envstring = varchar(256))
integer
Sets the value of an environment variable
Defined
WinHelp
(command =
integer
[, helpfile = varchar]
[, context = integer]
[, topic = varchar])
integer
Displays a compiled help file
Defined