The complete command listing uses a standardized format to make locating information easier. The layout of each command is illustrated in the following example.

Description

Icons adjacent to a command name indicate whether a command is pertinent to Lotus Notes development only, or OpenInsight only. Commands available to both are not marked. Icons and their meanings are as follows.

Indicates the command is specific to Native Tables.

Indicates the command is specific to Client/Server. Symbols adjacent to the command name indicate whether a command is available programmatically, or can only be called from the command line in the System Editor, or is available for use in both situations. Symbols and their meanings are as follows. Symbol Description Command is available programmatically. Command is available from the command line in the System Editor.

Syntax

Name (parameter1 {parameter2,...})

- OR -
Alternate forms of the syntax follow, if applicable.

• The name of the operation appears in uppercase; parameters are represented by italic place holders, indicating specific information that you supply.
• All items in the syntax should be entered on a single line. The Access editor will allow you to do so by continually scrolling right until you enter a carriage return.
• Optionally, you can make your code more readable by entering a vertical bar symbol (|) to indicate a wrap to the next line. The compiler will treat the line following the vertical bar as an extension of the line containing the vertical bar.
• A pair of brackets [ ] surrounding a parameter indicates the item is optional. To include the optional parameter, enter only the information, not the brackets themselves. (Note that this usage differs from the Brackets operator.)

The vertical bar symbol (|) is used two ways in this reference:

• In a syntax line, a vertical bar separates mutually exclusive items. You must choose one.
• In code samples, which are in a monospaced typeface, the vertical bar tells the compiler that the following line is an extension of the current line.

Parameters

The "Parameters" section provides important information about the syntax, including parameters and their descriptions. Parameters are explained in a table, as follows.

Remarks

The "Remarks" section provides additional information about the syntax, including special situations to bear in mind.

See also

This section directs you to other sources of information about the command or related commands.

Example

A code example may also be provided. If so, it will appear in monospaced typeface. Code samples for the command may also be available in the sample application that is provided with the product.