Category: ZIM 4GL Language Reference

PAGE RIGHT

Specifies the vertical footing for each page in a column-oriented report.

Syntax

PAGE RIGHT reportitem [:format:]

Parameters

reportitem

Any valid expression. Complex expressions must be enclosed in parentheses. When you specify more than one expression, each must be separated from the next by at least one space.

format

A set of instructions defining the format for the associated reportitem. Format is enclosed in : (colons) and can consist of any valid combination of format options.

Comments

The PAGE RIGHT “footing” is placed along the right-hand edge of each page in a column-oriented report. The column of text generated by this command ends in the right-most column of the page. Report items in this command can include individual data values only from the last record processed on the current report page; however, summary information computed over all the members on the current report page (using aggregate functions) can be displayed in the footing.

 

See Also

How to Use The Report Generator

Output Masks

Report Item Format Options

DELETE

Deletes data from EntitySets or relationships with fields.

Syntax

DELETE [num] [setspec] [EVALUATE clause] [-> clause]

Parameters

numCan be
an integer constant (15, 200);
a variable, a form field, or a parameter that evaluates to an integer;
the word ALL.
If num is omitted, or less than 0, it defaults to 1.
setspecThe set specification for the simple set whose records you want to delete. If omitted, records are deleted from the current set (if it exists).

Comments

Records cannot be deleted from a composite set. Data cannot be deleted from application documents or forms.
If the target of DELETE is a set object or result set, deletion always starts at the current member of the set.

Data removed from the database by a DELETE command cannot be recovered.

Example

delete

Deletes the current member of the current set.

delete 5 Employees where DeptNum = D01

Deletes the first five records in Employees where the department number is D01.

See Also

$MemberCount

DELETE FROM

ENCRYPT

Encrypts the data in an EntitySet or relationship with fields.

Syntax

ENCRYPT object

Parameters

objectThe name of an EntitySet or a relationship with fields. Can be a role name.

Comments

The ENCRYPT command makes stored data meaningless to anyone scanning a raw database file on disk, thereby protecting the data from unauthorized access. The encryption key is established when the New Database utility is executed.
If the data in the specified object has already been encrypted, reissuing the command raises an error.
The ENCRYPT and DECRYPT commands prevent users outside of an application session from reading sensitive data contained in disk files. All encryption and decryption in a particular database is based on a key established when you initiate a new database .
Encrypted EntitySets and relationships are accessed in exactly the same way as un-encrypted EntitySets or relationships. Internally, the software automatically decrypts data from an encrypted file as you work with that file. A slight performance penalty is paid for working with encrypted data.
An encrypted object can be returned to normal with a DECRYPT command.

See Also

DECRYPT

Securing Data Inside an Application

HALT

In application programs, sets break points where execution is to be halted.

Syntax

HALT

Comments

The HALT command suspends execution of the currently executing application program and displays the HALT prompt (>>) at the terminal. You can then enter any command, including a call to another program.

The SET SINGLESTEP ON command causes the HALT command to be automatically executed after each command in the currently executing program.

If executed at the HALT prompt, BYE, RETURN, STOP, and global SET commands act in the usual manner. Local SET commands (e.g., LEXTRACE, RUNTIME, FLOW) is applied to the suspended program when it resumes.

If desired, you can redefine HALT to perform any useful function.

To re-define HALT, first ERASE the HALT program. Next, change the definition of HALT in the Documents EntitySet: make HALT correspond to a disk file called HALT.DOC. CREATE HALT again, ensuring that HALT.DOC contains the commands to perform the desired function.

For example, if you wanted to track memory use, HALT.DOC can contain the line:

system ” chkdsk”

% this command shows memory use

If you were to issue the command SET SINGLESTEP ON, the new version of HALT would be executed after every command, giving you a continuous record of disk and memory use.

Example

halt  % at >> prompt, you can turn on tracing,

   % output variables, etc.

 

GRAPH

Starts a graphics program.

Syntax

GRAPH expression [ RESET|CLOSE] [INVISIBLE] [BACKGROUND]

Parameters

expression

 

A character string, or expression that evaluates to a character string. The content of the string is passed to the graphics program call (e.g., parameters). If no parameters are required, specify the null string.

 

RESET

 

Flushes all internal data buffers to disk.

 

CLOSE

 

Flushes all internal data buffers to disk, and closes all files not currently in use.

 

INVISIBLE

 

Executes the graphics program without affecting the screen display.

 

BACKGROUND

 

Executes the graphics program asynchronously while Zim continues to run. You can continue working, and have a number of graphics sessions running concurrently.

 

Note: BACKGROUND is ignored in some operating environments.

Comments

The value of the system variable $Graphics identifies the graphics program to be run. If $Graphics has not been assigned a value, the default value is used.

When you exit a graphics program that was not run in the BACKGROUND, execution of your application program resumes following the call to the graphics program.

 

See Also

EDIT

SYSTEM

EDIT

Starts a text editor to edit an application document.

Syntax

EDIT docname [BACKGROUND]

Parameters

docname

The name of an application document.

BACKGROUND

Indicates that the editor is to be executed asynchronously while the application continues to run.

Comments

The value assigned to $Editor should be the full path and file name of the desired text editor.

With BACKGROUND omitted, the EDIT command causes execution to be suspended; the editor takes over. When you exit from the text editor, execution resumes from the point at which the EDIT command was encountered.

With BACKGROUND specified, the editor can be running in its own window while the application continues to execute. You can have concurrent editing sessions.

Note: Any return code that is generated by the editor is placed in the $ErrCode system variable.

BACKGROUND is ignored in some operating environments and when using Zim Thin Client.

Example

To start a text editor, edit.com, for editing MainProg, enter

let $Editor = “NotePad”

edit MainProg

that sets the $Editor system variable to the name of the desired edit program. It then calls up that program to edit the specified file.

 

See Also

$Editor

$ErrCode

GRAPH

SYSTEM

REPORT HEADING

Specifies the report heading.

Syntax

REPORT HEADING [TEMPLATE name] reportitem [:format:]

Parameters

TEMPLATE name

For graphical reports, the name of an optional template to define the layout of the report.

reportitem

Any valid expression. Complex expressions must be enclosed in parentheses. When you specify more than one expression, each must be separated from the next by at least one space.

format

A set of instructions defining the format for the associated reportitem. Format is enclosed in : (colons) and can consist of any valid combination of format options.

Comments

Generates a line-oriented heading at the start of a report, regardless of whether the report itself is line-oriented or column-oriented. To generate column-oriented headings, use the BREAK (Reports) command with a constant expression.

Typically, the items specified are text (for titles), blank lines, dates, and so on. The heading can include individual data values only from the first member of the REPORT FROM set.

 

See Also

How to Use The Report Generator

PAGE FOOTING

REPORT FOOTING

Report Item Format Options

PREVIOUS

Moves the current member pointer one or more records “up” in a result set.

Syntax

PREVIOUS [num] [setname]

Parameters

num

 

The number of members “further up” into setname that the current member pointer is to be moved. Num can be:
an integer constant (15, 200);
a variable, form field, or parameter that evaluates to an integer;
the word ALL.
The default value for num is 1. If num is negative, PREVIOUS num actually moves the current member pointer “down” in the set.

 

setname

 

The name of a result set. If setname is omitted, the current set is used.

 

Comments

UP is a synonym for PREVIOUS.

Example

previous 10

Moves the current member pointer 10 members “up” towards the start of the set.

previous 5 MySet

list 5 MySet

Moves the current member pointer “up” five members, then lists five members (starting with the new current member).

 

See Also

$currentmember

BOTTOM

DOWN

LOCATE

NEXT

TOP

CURSOR

Positions the text cursor in the current window.

Note: This command has been deprecated in Zim 8.50.
It is still accepted for backwards compatibility, but it is ignored.

Syntax

CURSOR expression1 expression2

Parameters

expression1A number or an expression that evaluates to a number. If the expression is complex, it must be enclosed in parentheses.
Indicates the character row in which the cursor is to be positioned. It should be a number from 1 to the maximum number of rows in the current window.
expression2A number or an expression that evaluates to a number. If the expression is complex, it must be enclosed in parentheses.
Indicates the character column in which the cursor is to be positioned. It should be a number from 1 to the maximum number of columns in the current window.

Comments

The text cursor is placed at the specified row (expression1) and column (expression2) coordinates.

Examples

cursor 10 (60/2)
output "Press Enter to continue" ;
input

Positions the cursor at row 10 and column 30, and displays a message.

input $CursorRow $CursorCol
cursor $CursorRow $CursorCol

Prompts for a new cursor position, and moves the cursor.

LOGIN

Identifies the current user to Zim for security purposes.

Syntax

LOGIN username [password]

Parameters

username

A character string, or an expression that evaluates to a character string.
The character string is checked against the list of valid user names (as defined in the Users EntitySet). User names are case-sensitive.
Complex expressions must be enclosed in parentheses.

password

A character string, or an expression that evaluates a character string.
If username does not have a defined password, any password entered is ignored.
Complex expressions must be enclosed in parentheses.

Comments

The LOGIN command can be entered at any time during an application session.

When the software is started, it automatically tries to log the user as the default user ZIM. If ZIM is not a defined user in the Users entity set, access to any EntitySets or relationships is denied.

Example

If your user name is Boss and your password is $profits, to log in use

login “Boss” “$profits”

If you do not have a password, all you need to login is

login newuser

This example can be used if the application uses a log-in form

login fLogin.Username fLogin.Password

 

See Also

PASSWORD

PERMISSION

Securing Data Inside an Application

en_CAEnglish
pt_BRPortuguese en_CAEnglish