BREAK (Loops)

Exits from a WHILE loop.

Syntax

BREAK

Comments

Upon encountering a BREAK command, the software continues execution at the first command following the ENDWHILE of the “innermost WHILE loop” containing the BREAK.

Any IF or CASE statements that are still open when a BREAK command is executed are automatically closed.

Example

Consider the following code fragment:

while var1 > 20

.. some commands …

if var2 = 1

break

else

 … more commands …

endif

 … still more commands …

endwhile

… commands after the WHILE loop …

When var2 is set to 1, the only commands executed in the above sequence are “some commands” and “commands after the WHILE loop”. Commands between the BREAK and ENDWHILE commands are ignored, and the “open” IF statement is automatically closed.

See Also

CONTINUE

GOTO

WHILE

SCREEN CLEAR

Clears the screen and establishes the application window (BACKSCREEN) as the current window.

Syntax

SCREEN CLEAR

Comments

The SCREEN CLEAR command clears the contents of the application window (BACKSCREEN), hides any other windows that are currently displayed, makes the application window the current window, and places the cursor at the top, left-hand corner of the application window.

Although hidden, all other windows remain open and active. To re-display the hidden windows, use either the SCREEN RESET or WINDOW DISPLAY BACKSCREEN HIDE command.

Example

window clear backscreen

window set current backscreen

window display backscreen

The SCREEN CLEAR command is equivalent to the preceding sequence of commands.

screen clear   % clear prev. data & expose application window

output “Output to printer? (y/n)” ;

input Response

if Response = “y”

 set output printer

endif

screen reset

See Also

CLEAR

WINDOW CLEAR

DISCONNECT

Releases a connection to Zim Integrated Server on to an SQL database.

Syntax

DISCONNECT FROM [ “ZIMSERV” | “JDBCSAM” | alias name ]

Parameters

The alias name is one of the defined ones in the zimalias.zim configuration file.

Comments

The DISCONNECT command should only be issued after a CONNECT command has been successfully executed in order to disconnect a previous connected session. The name of the server to be used in DISCONNECT must be the same used in CONNECT.

Example

> connect to ”JDBCSAM” using (“Sales”, “MySQL”, “TheUser”, “ThePassword”,”5455″, “123.123.123.123”)

> disconnect from ”JDBCSAM”

> connect to ”ZIMSERV” using (“Inventory”, “”, “JOE”, “PASSWORD”, “Joes_Server”, “LinuxAirport”)

> disconnect from ”ZIMSERV”

 

See Also

COMPILE

CONNECT

SET COMPILEMODE

SET EXECUTEMODE

SET SQLCOMPILE

SET SQLTRACE

UNCOMPILE

GOTO NEXT

Branches from an exception handler to the command immediately following the command that caused the exception.

Syntax

GOTO NEXT

Comments

GOTO NEXT is used only in an exception handler and only to branch to the command immediately following the one that caused the exception to occur. GOTO NEXT exits the exception handler, and closes it in the same way as ENDON.

Example

procedure DoReports()

 on break

  output “*** Report Terminated by User ***”

  goto next

 endon

 report from clients (unrelated) placed orders

  (report commands)

 endreport

 report from products (unrelated) require orders

  (report commands)

 endreport

 report from orders (unrelated) issued invoices

  (report commands)

 endreport

endprocedure

If a break condition occurs during the generation of a report, a message is output and execution resumes at the command following the one that was interrupted.

See Also

GOTO

GOTO PREVIOUS

ON

UP

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

Syntax

UP [num] [setname]

Parameters

numCan be:
an integer constant (15, 200);
a variable, form field, or parameter that evaluates to an integer;
the word ALL.
The default value of num is 1.
If num is negative, the command effectively becomes a DOWN or NEXT command.
setnameThe name of a result set. If setname is omitted, the current set is used.

Comments

PREVIOUS is a synonym for UP.

Example

up 10

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

up 5 MySet

list 5 MySet

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

See Also

$currentmember

BOTTOM

DOWN

LOCATE

NEXT

PREVIOUS

TOP

DISPOSE

Releases memory occupied by user-defined variables (including form fields and menu items) or result sets.

Syntax

DISPOSE option

Parameters

optionCan be
«item»
The name of a variable, form field, menu item, form or menu whose current memory allocation is to be released.
ALL
Releases the current memory allocation of all user-defined variables, form fields, and menu items.
SET
Causes all result sets to be reset to empty.

Comments

DISPOSE releases the memory where the current values of variables (including form fields and menu items) are stored. As a result, the objects whose values were stored in that memory become $Null. DISPOSE does not close or erase the objects themselves.

Example

dispose all

Releases memory used to store current values of all variables, form fields, and menu items in an application.

dispose Form1 Menu1

Releases the memory used to store the current values of all form fields in the specified form and menu.

DECRYPT

Decrypts the data in an EntitySet or relationship with fields.

Syntax

DECRYPT object

Parameters

objectThe name of a previously encrypted entity set or a relationship with fields. A role name can be used.

Comments

Reverses an ENCRYPT command.

If the data in the specified EntitySet or relationship was not previously encrypted, 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. Within Zim, encrypted data is automatically decrypted as the application programs work with it. All encryption and decryption in a particular database is based on a key established when you initiate a new database by executing the New Database (ZIMINIT) administrative utility.

Encrypted EntitySets and relationships are accessed in exactly the same way as unencrypted 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.

See Also

ENCRYPT

Securing Data Inside an Application

RENAME

Changes the name of certain objects.

Syntax

RENAME object oldname AS newname [IN directory]

Parameters

objectOne of
CONSTANT, DIRECTORY, DISPLAY, DOCUMENT, ENTITYSET, FORM, RELATIONSHIP, ROLE, SET, VARIABLE, WINDOW
oldnameThe current name of object.
newnameThe new name for object. The new name must not be the name of an existing object.
directoryThe name of the application directory in which object is located.

Example

rename entityset Deppartments as Departments

The preceding command renames an EntitySet that was accidentally given a misspelled name.

See Also

CREATE

ERASE

How To Name Objects

PAGE LEFT

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

Syntax

PAGE LEFT reportitem [:format:]

Parameters

reportitemAny 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.
formatA 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 LEFT command generates a “heading” along the left-hand edge of each page in a column-oriented report. The column of text generated by this command starts in column 1 on the page. Report items in this command can include individual data values only from the first record to be processed on the current report page.

See Also

How to Use The Report Generator

Output Masks

Report Item Format Options

TRANSACTION

Starts an explicit transaction.

Syntax

TRANSACTION [READ]

Parameters

READThis option is ignored.

Comments

TRANSACTION marks the start of a sequence of commands that are to be handled as a single transaction. The transaction can be terminated either with an ENDTRANSACTION or  with a QUITTRANSACTION command.

TRANSACTION sets the system variable $InTransaction to $True.

Example

form set accelerator Return Escape

while

 form open fEmpForm

 form display input

 if Event.EventName <> “Escape”

  find Departments where Departments.Dno=fEmpForm.Dno

  if $setcount = 0

   form open fDeptForm

   form display input

  endif

  transaction

   if $setcount = 0

    add Departments from fDeptForm

   endif

   add Employees from fEmpForm

  endtransaction

 else

  return

 endif

endwhile

See Also

BEGIN WORK

ON

QUITTRANSACTION

SET TRANSACTION FLOW

pt_BRPortuguese