A script-enabled browser is required for this page to function properly.

Individual Built-in Descriptions

The remainder of this chapter presents individual Built-in descriptions. Each Built-in is presented in the following format or a subset of the format, as applicable:

Syntax

Describes the syntax of the Built-in. If there are multiple formats for a Built-in then all formats are shown. For example, if the target object of a Built-in can be called by name or by object ID, then both forms of syntax are displayed.

Built-in Type Indicates whether the Built-in is restricted or unrestricted

Returns Indicates the return value or data type of a Built-in function

Enter Query Mode Indicates the capability to call the Built-in during enter query mode.

Description

Indicates the general purpose and use of the Built-in.

Parameters

Describes the parameters that are included in the syntax diagrams. Underlined parameters usually are the default.

Individual Built-in descriptions Restrictions

Indicates any restrictions.

Individual Built-in descriptions Examples

Provides an actual example that can be used in conjunction with the syntax to develop a realistic call to the Built-in.