LU 6.2 API Application Programmer's Reference Guide (30294-90008)

64 Chapter5
Intrinsic Descriptions
Syntax Conventions
Syntax Conventions
The syntax description for each intrinsic is given in the following form:
Syntax
I32 I16V I16
INTRINSIC NAME ( parameter1 , [ parameter2 ], parameter3 )
Optional parameters, like parameter2 , are enclosed in square brackets.
Required parameters, like
parameter1 and parameter3 , are not
enclosed in brackets.
NOTE Any optional parameters that are not used in an intrinsic call must
have place holders. In most languages, a comma serves as a place
holder.
Output parameters (parameters whose values are returned to the
program after intrinsic execution) are underlined. In the example
above,
parameter3 is an output parameter.
Input parameters (parameters whose values are passed to the intrinsic
in the intrinsic call) are not underlined. In the example above,
parameter1 and parameter2 are input parameters.
Input/output parameters are underlined. Input/output parameters are
used to pass a value to the intrinsic and then to return a value to the
program after intrinsic execution.
The mnemonics that appear over the parameters indicate their data
type and whether they are passed by reference (the default) or by value.
The mnemonics are defined in Table 5-1 and Table 5-2.
A parameter passed by value will have a V next to the mnemonic. For
example, I16V indicates a 16-bit integer passed by value. A parameter
without a V next to the mnemonic is passed by reference. All arrays are
passed by reference.