Category: ZIM User Documentation

The Original Internet Language

$ObjErrHelpFile

Provides the name of the help file that the component provided when an exception was raised. Syntax $ObjErrHelpFile Return Value Character string (VARALPHA). Can be reset by an application program. Comments The variable provides the name of the help file that the component provided when an exception was raised because of an  improper operation. This…
Read more

$ZimPath

File system path to the directory in which the Zim software is installed. Syntax $zimpath Return Value A path name. Cannot be reset by an application program. Description $ZimPath is set to the value of the Zim entry in the registry. If this value is not set, the variable is set to the null string…
Read more

$ObjException

A variable set when an exception occurs. Syntax $ObjException Return Value Number (LONGINT) Can be reset by an application program. Comments This variable is set only when a Zim error 5207 is generated (when the component application wishes to raise an exception). When an exception is raised, this variable is set as well as $ObjErrCode,…
Read more

$ObjErrHelpTopic

Provides a topic number for the help file provided by $ObjErrHelpFile. Syntax $ObjErrHelpTopic Return Value Number (LONGINT). Can be reset by an application program. Comments The variable provides a topic number for the help file provided by the $ObjErrHelpFile. This topic number does not apply to all help files formats. This variable is set to…
Read more

$ProgramName

Syntax $ProgramName Return Value Character string (varalpha). Cannot be reset by an application program. Comments Contains the name of the currently executing program. See Also SET LEXTRACE SET TRACE

RESET CONNECTOR DOCUMENT

Resets the connector document file name to its original file name. Syntax RESET CONNECTOR DOCUMENT «connector document» Parameters connector document The name of a connector document. Comments The RESET CONNECTOR DOCUMENT resets the filename for the connector document back to the value found in the Zim directory. The reset value will be used on all…
Read more

$ZimOS

Indicates the operating system under which Zim:X is currently running. Syntax $zimos Return Value A number as stated below. It cannot be reset by an application program.   Value Operating System 3 All Linux Flavours 11 Microsoft Windows 12 Linux Running on Android

SET DATABASE ACCESS

Sets an exclusive or shared access to a database. Syntax SET DATABASE ACCESS EXCLUSIVE|SHARED Comments This command enables a specific user (usually the database administrator) to grant himself/herself exclusive access to a ZIM database. Under normal conditions, database access is shared among users; however, in some situations, the administrator may want exclusive access to the…
Read more

$ObjErrParameter

Provides the number of the parameter that caused an error. Syntax $ObjErrParameter Return Value Number (INT). Can be reset by an application program. Comments If a Zim error of 5201 (Unknown Parameter) or 5202 (Type Mismatch) occurs, the $ObjErrParameter is set to the number of the parameter that caused the error. If the 5201 error…
Read more

ENDPROCEDURE

Marks the end of a procedure. Syntax ENDPROCEDURE Comments ENDPROCEDURE is used only in conjunction with a LOCALPROCEDURE or PROCEDURE command. It is the last command of a procedure in an application program. See Also LOCALPROCEDURE PROCEDURE

en_CAEnglish