This chapter provides you with a listing of available BASIC+ commands, appropriate syntax, their parameters, and code samples. In this chapter, command types include functions, subroutines, statements, operators, and routines.
Commands in this chapter are organized in alphabetical order, and may be pertinent to programming for Lotus Notes, OpenInsight, or both. Commands specific to programming in Lotus Notes or OpenInsight (native) tables are labeled with an icon to make identification easier. Those which are available in both situations are not labeled.
For information about OpenInsight properties and events, refer to Chapter 4: Properties and Chapter 5: Events, respectively.
The complete command listing uses a standardized format to make locating information easier. The layout of each command is illustrated in the following example.
[Command Name]
[Operator Type]
Description
The command name is followed by a brief 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.
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.
The "Parameters" section provides important information about the syntax, including parameters and their descriptions. Parameters are explained in a table, as follows.
| Parameter | Description |
|---|---|
| Parameter 1 | A description of each parameter shown in the syntax line, along with any additional values required by the parameter. |
The "Remarks" section provides additional information about the syntax, including special situations to bear in mind.
This section directs you to other sources of information about the command or related commands.
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.
CALCMAXLEN Get_Printer Message
CALCMAXLEN Set_Printer Message
CREATE_DIALOG() Function (oi 9.x)
CREATE_DIALOG() Function (oi 10)
CREATE_XML_XSD_SCHEMA() Function
CURRENTDEVICE Get_Printer Message
CURRENTDRIVER Get_Printer Message
FONTHEADFOOT Get_Printer Message
FONTHEADFOOT Set_Printer Message
FORWARD_EVENT Subroutine (oi 9.x)
GETDEFAULTCHARACTER() Function
GETMINIMUMDELIMITER() Function
GETSESSIONCALLSTACK() Function
GET_EVENTSTATUS() Function (oi 9.x)
ICONV() DATETIME (DT) Function
ICONV() ENCRYPT_FORMAT Function
ICONV() MASKED DECIMAL (MC,MD) Function
ICONV() MASKED SCIENTIFIC (MS) Function
ICONV() VARIABLE BINARY (VB) Function
ISEVENTCONTEXT() Function (oi 9.x)
OCONV() DATETIME (DT) Function
OCONV() ENCRYPT_FORMAT Function
OCONV() MASKED CHARACTER (MCX) Function
OCONV() MASKED DECIMAL (MC, MD) Function
OCONV() MASKED SCIENTIFIC (MS) Function
OCONV() MX, HEX, MO, MB Function
OCONV() VARIABLE BINARY (VB) Function
ORIENTATION Get_Printer Message
POST_EVENT() Function (oi 9.x)
PREVIEWMODE Get_Printer Message
PREVIEWMODE Set_Printer Message
PRINTERINFO Get_Printer Message
PRINTQUALITY Get_Printer Message
RTI_CREATE_USER_DETAILS() Function
RTI_EXPIRATION_DATE() Function
RTI_GET_CURRENT_SYMBOLIC() Function
RTI_GETNETWORKUSERNAME() Function
RTI_REMOVE_STYLE_SHEET() Function
SEND_EVENT() Function (oi 9.x)
SETDEBUGGER() Function (oi 10)
SETDEFAULTCHARACTER Subroutine
SETMINIMUMDELIMITER Subroutine
SET_EVENTSTATUS() Function (oi 9.x)
SET_EVENTSTATUS() Function (oi 10)
SET_PROPERTY() Function (oi 9.x)
SET_PROPERTY_ONLY() Subroutine
STARTTABLE Set_Printer Message
START_MDICHILD() Function (oi 9.x)
START_MDICHILD() Function (oi 10)
START_WINDOW() Function (oi 9.x)
START_WINDOW() Function (oi 10)