Asynchronous Serial Communications Programmer's Reference Manual (32022-90052)

Chapter 8 155
Intrinsics Reference
Intrinsic Descriptions
NOTE A parameter passed by value is indicated by appending V to the
mnemonic. Pass by reference is considered to be the default and,
consequently, is not marked. All arrays are assumed to be passed by
reference.
In the FFILEINFO intrinsic shown previously, there is one required
parameter (filenum), and a pair of optional parameters that can be
repeated up to five times (
itemnum and item ). The * over the item
parameter indicates that the type of the parameter will change
according to an associated factor (in this case, the value associated with
itemnum determines what the item parameter will contain and
therefore its type).
Use
This paragraph describes how to use the intrinsic. It provides a more
complete description than the brief summary given under the intrinsic
name.
Functional Return
If applicable to the intrinsic being described, the functional return
value will be explained here. If the intrinsic does not have a functional
return, this paragraph of the intrinsic description is omitted.
Parameters
All parameters are described, including their data type, whether they
are passed by reference or by value, and whether they are required or
optional. Any default values for optional parameters are noted here.
The description also includes whether the parameter is used to pass
information from the program, return information to the program, or
both.
For some parameters certain bit settings have particular meanings;
when significant, these bit settings and their meanings are described.
Bit groups are denoted using the standard notation (starting bit
number:length). Thus bit (15:1) indicates bit 15; bits (0:3) indicates bits
0, 1 and 2.
In some cases bits within a word are described as being reserved for
MPE/iX. You should always set these bits to zero to be sure your
program will remain compatible with future MPE/iX releases.
Notes
A special notes section is included in the explanation of the individual
FCONTROL functions, and provides additional information regarding
their use.