Suspends the execution of an application for a specified period of time.
Syntax
SLEEP seconds
Parameters
seconds | A number, or an expression that evaluates to a number, representing the number of seconds to “sleep”. |
Comments
When the SLEEP command is encountered in a procedure, execution is suspended for the specified number of seconds. If seconds is negative, zero, or $Null, execution is not suspended.
See Also
PAUSE
Obtain information about a particular parameter created by the current event raised by a COM component.
Syntax
$ObjEventParameter (ParameterNumber)
Return Value
Returns a result that can be a component object or a string for the passed parameter number.
Comments
The Event structure displays information about the last event that caused form input to terminate. The proprietary events of an object can trigger Zim to terminate form input. To trigger this, use the command
FORM SET (OBJECTEVENT . . .)
When the proprietary events of an object cause forms input to terminate, the eventname field is set to the name of the event and the event type is set to formfield.
Often the proprietary events of an object pass along extra information in the form of parameters. These parameters can be queried using the $ObjEventParameter function.
Warning
COM objects are being discontinued by Microsoft and may not be available in future releases of Zim-X.
Marks the end of a group of report commands.
Syntax
ENDREPORT
Comments
The ENDREPORT command is used only in conjunction with a REPORT FROM command. It marks the end of a report.
When an ENDREPORT is encountered, the current group of report commands is processed. The resulting report is directed to the current output device.
See Also
BREAK (Reports)
COLUMN BREAK
DETAIL LINE
How to Use The Report Generator
REPORT FOOTING
REPORT FROM
REPORT HEADING
Specifies how a field’s ListWidth is treated in a LIST command.
Syntax
SET OUTPUT FIELDLISTWIDTH ON|OFF
Comments
The OUTPUT FIELDLISTWIDTH option is set ON by default.
When OUTPUT FIELDLISTWIDTH is ON, the LIST command formats output according to each field’s established ListWidth. Setting FIELDLISTWIDTH to OFF causes the software to ignore the established ListWidth and to format all fields to their maximum length. Fields with an established ListWidth of -1 therefore appear in the output.
See Also
LIST
SELECT
File system path to the application user’s work directory (specified in a Zim configuration file).
Return Value
A character string. Cannot be reset by an application program.
Description
The current work path as specified in the configuration file.
To indicate the current WorkPath directory in a file name, start the name with a close parenthesis ( ) ) character.
See Also
$ClipPath
$DBPath
$ImagePath
$ZimPath
Controls how special characters in unstructured application documents are treated.
Syntax
SET SPECIALSCAN ON|OFF
Comments
The SET SPECIALSCAN command is set ON by default.
When SPECIALSCAN is ON, the backslash () and asterisk (*) characters have special meanings when they appear in an unstructured application document that is being used as a data source in an ADD or CHANGE command. Setting SPECIALSCAN to OFF causes the backslash and asterisk to be treated as normal characters by these commands.
See Also
ADD
CHANGE
SET DELIMITER
Causes execution to be halted and a message to be output.
Syntax
PAUSE
Comments
When the software encounters a PAUSE command, it halts execution (pauses) and displays the message:
Press to continue.
Pressing Enter causes execution of the current application program to resume at the command that follows the PAUSE.
The SET PAUSE command governs pauses during output from the LIST and OUTPUT commands. A PAUSE feature is also built into the REPORT FROM command.
The PAUSE message can be altered using the Language Customizer utility.
See Also
FORM INPUT
INPUT
SLEEP
The location of focus on the screen when an event occurs.
Syntax
$cursorscreenrow
Return Value
The number of the character row where focus is located on the terminal screen at the time of an event. Can be reset by an application program.
Description
The number of the character row where focus was located on the terminal screen at the time of an event.
Rounds a number to the nearest integer.
Syntax
$round(number)
Parameters
number | a number, or an expression that evaluates to a number |
Return Value
Number, with no decimal places.
Example
$round(2.501)
Evaluates to 3.
$round(2.4999)
Evaluates to 2.
$round($substring("123.456",3,3))
Evaluates to 3.
See Also
$money
$tonumber
$truncate
Ends execution of an application program and returns to the main prompt level.
Syntax
STOP
Comments
The STOP command stops execution of the current application program and returns control to the main prompt level (i.e., outside any application program). STOP is equivalent to BYE when used in a fully compiled application running under the Runtime system.
Example
find all Employees where Salary > 10000
if $setcount = 0
stop
endif
The preceding command returns control to the main prompt level when no set results from the execution of a FIND command.
See Also
BYE
RETURN
TRANSFORM