guides:programming:programmers_reference_manual:chapter_basic_command_reference

BASIC+ Command Reference

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.

ParameterDescription
Parameter 1A 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.

CALCBMP Get_Printer Message

CALCBMP Set_Printer Message

CALCMAXLEN Get_Printer Message

CALCMAXLEN Set_Printer Message

CALCTABLE Get_Printer Message

CALCTABLE Set_Printer Message

CALCTEXT Get_Printer Message

CALCTEXT Set_Printer Message

CALCULATE() Function

CALLFUNCTION() Function

CALLSUBROUTINE() Function

CALL Statement

CANCEL Get_Printer Message

CASE Statement

CHANGE_POPUP_FONT Subroutine

CHANGE_WINDOW_FONT Subroutine

CHAR() Function

CHECKLEGALUSER() Function

CHOOSECOLOR Service

CHOOSEDIR Service

CHOOSEFILE Service

CHOOSEFONT Service

CLEARDRAGDATA Message

CLEARFILE Statement

CLEARFLAG Method

CLEARMODULE Method

CLEARSELECT tatement

CLEAR_TABLE Subroutine

CLOSEENGINE() Function

CLOSEQUEUE() Function

COL1() Function

COL2() Function

COLCHARS Message

COLDROPDOWNLIST Message

COLHEADING Statement

COLLABEL Message

COLLATE Set_Printer Message

COLLECT.IXVALS() Function

COLLENGTH Statement

COLOR_BY_POS Message

COLSTYLE Message

COLWIDTH Message

COMMON statement

COMPILE Method

COMPUTE_DICT() Function

CONTEXTMENU() Function

CONTROL Get_Printer Message

CONTROL_OFF Routine

CONTROL_ON Routine

CONTROL Set_Printer Message

CONVERT Statement

COPIES Get_Printer Message

COPIES Set_Printer Message

COPYFILE Service

COPYOSFILE() Function

COPY Message

COPY Method

COPY_OS_TO_ROW Routine

COPY_ROW Subroutine

COPY_ROW_TO_OS Subroutine

COPY_TABLE Subroutine

COS() Function

COUNT() Function

CREATEBINARYDATA() Function

CREATEENGINE Constants

CREATEENGINE() Function

CREATEQUEUE() Function

CREATEREQUEST() Function

CREATE_DIALOG() Function (oi 9.x)

CREATE_DIALOG() Function (oi 10)

CREATE_INDEX Subroutine

CREATE Service

CREATE_SYMBOLIC Routine

CREATE_TABLE Subroutine

CREATE_USER Subroutine

CREATE_VOLUME Subroutine

CREATE_XML_XSD_SCHEMA() Function

Cross Reference Indexes

CURRENTDEVICE Get_Printer Message

CURRENTDRIVER Get_Printer Message

CURRENTPORT Get_Printer Message

CURSOR Service

CUT Message

Readnext..By Statement

READNEXT Statement

READONLY Property

READO Statement

READV Statement

READ_COLUMN Routine

READ_ROW Routine

READ Statement

RECOMPILE_PROC Subroutine

RECT Set_Printer Message

REDUCE Subroutine

REFRESH_VSPRINTER Subroutine

Related Topics

Relational Indexes

REMOVEDIR Service

REMOVEDRAGDATA Message

REMOVEMODULE Method

REMOVE Statement

REM() Function

RENAMEDIR Service

RENAMEFILE Service

RENAME_TABLE Subroutine

REPLACE() Function

REPOSITORY() Function

RESETPAGE Set_Printer Message

RESETZORDER Message

RETSTACK() Function

RETURN Statement

REVRUN Executable

REV_UTILITY() Function

RGB() Function

RLIST Routine

RND() Function

ROWEXISTS() Function

ROWHEIGHT Message

RTI_AUTOEXEC Subroutine

RTI_BITMAP_INDEX_SEARCH

RTI_CDOMAIL() Function

RTI_CREATEGUID() Function

RTI_CREATE_USER_DETAILS() Function

RTI_CRYPTO() Function

RTI_DISTINCTLIST() Function

RTI_EMAIL_CLIENT() Function

RTI_ERRORTEXT() Function

RTI_EXPIRATION_DATE() Function

RTI_FIX_USERS() Function

RTI_GET_CURRENT_SYMBOLIC() Function

RTI_GETMAIL() Function

RTI_GETNETWORKUSERNAME() Function

RTI_GET_PROC_INFO() Function

RTI_IDE_CFG() Function

RTI_INDEXER Subroutine

RTI_JSON Function

RTI_LIST() Function

RTI_LOAD_DATABASE() Function

RTI_LOCK_OWNER() Function

RTI_OS_DIR() Function

RTI_OS_DIRECTORY() Function

RTI_PARSECSV() Function

RTI_READU Equates

RTI_READU() Function

RTI_REMOVE_STYLE_SHEET() Function

RTI_RUN_COMMAND

RTI_RES2STR() Function

RTI_SENDFAX

RTI_SENDMAIL() Function

RTI_SETS() Function

RTI_STRINGBUILDER Routine

RTI_TASKMANAGER() Function

RTI_TASK_CREDENTIALS() routine

RTI_TASK_SCHEDULER() Function

RTI_TASK_SHUTDOWN() Function

RTI_TASK_STARTUP() Function

RTI_TASK_STATUS() Function

RTI_TASK_SUBMIT() Function

RTI_TRANSACTION Subroutine

RTI_UTIL_DROPBOX() Function

RTI_VERIFY_PROC() Function

RTI_WRITERELEASE() Function

RTI_WRITEU() Function

RTP1

RTP2

RTP3

RTP5

RTP7

RTP8

RTP9

RTP11

RTP11.INDEX

RTP12

RTP15

RTP16

RTP17

RTP18

RTP18ENGLISH

RTP19

rtp20

RTP21

RTP22

RTP25

RTP26

RTP27

RTP29

RTP31

RTP32

RTP33

RTP34

RTP36

RTP37

RTP38

RTP39

RTP42

RTP43

RTP49

RTP50

RTP53A

RTP57

RTP57A

RTP57.SUBS

RTP57.WIN

RTP65

RTP72

RTP90

RTP95

RTP99

RUNHELP Service

RUNWIN Service

RUN_BRW_REPORT

RUN_LABEL Subroutine

RUN_REPORT

SAVE_ENV Routine

SAVE_SELECT Subroutine

SCROLL Message

SELECT BY Statement

SELECT_INTO() Function

SELECT Statement

SELPOS_EX_BY_POS Message

SEND_EVENT() Function (oi 9.x)

SEND_EVENT() Function (oi 10)

SEND_INFO Subroutine

SEND_MESSAGE() Function

SEQ() Function

SERIAL() Function

SERIAL Get_Printer Message

SETACCESSPERMIT Method

SETANSITOUNICODE Subroutine

SETCHARFORMAT Message

SETDEBUGGER() Function (oi 10)

SETDEBUGGER Routine (oi 9.x)

SETDEFAULTCHARACTER Subroutine

SETDESCRIPTION Method

SETDRAGBITMAP Message

SETDRAGDATA Message

SETINITDIROPTIONS Subroutine

SETMINIMUMDELIMITER Subroutine

SETMODULE Method

SETNOOFDELIMITERS Routine

SETPUBLISHABLE Method

SETSHAREABLE Method

SETSUBKEY Method

SETSUB Method

SETSUPER Method

SETTITLE Method

SETUPDATEPERMIT Method

SETUTF8 Subroutine

SET_BGND_IX_TIME() Function

SET_DIALOG_INFO() Function

SET_DIALOG_PARAMS() Function

SET_ENV Routine

SET_EVENTSTATUS() Function (oi 9.x)

SET_EVENTSTATUS() Function (oi 10)

SET_FSERROR() Function

SET_IDXSVR() Function

SET_LANGUAGE() Function

SET Method

SET_MFS Subroutine

SET_PRINTER

SET_PROPERTY() Function (oi 9.x)

SET_PROPERTY Function (oi 10)

SET_PROPERTY_ONLY() Subroutine

SET_SORT_FILE() Function

SET_STATUS() Function

SET_VSPRINTER() Function

SET_ZORDER Message

Single Line IF Statement

SIN() Function

SPACE() Function

SQRT() Function

START32 Set_Printer Message

STARTOVERLAY

STARTTABLE Set_Printer Message

START Direct_Print Message

START_MDICHILD() Function (oi 9.x)

START_MDICHILD() Function (oi 10)

START_WINDOW() Function (oi 9.x)

START_WINDOW() Function (oi 10)

STATUS() Function

STOP32 Set_Printer Message

STOP Direct_Print Message

Stored Procedures

STRUCT_FLUSH Subroutine

STRUCT_LEN() Function

STRUCT_TO_VAR() Function

STR() Function

STYLE_BY_POS Message

SUBROUTINE Statement

SUM() Function

SUPPORTCOPIES Get_Printer Message

SUPPRESSKEYTRANSLATE Message

SWAP Statement

SWAP.CURSOR Subroutine

  • guides/programming/programmers_reference_manual/chapter_basic_command_reference.txt
  • Last modified: 2024/10/25 18:08
  • by bshumsky