DLL Programmer's Guide for TNS/R Systems

About This Manual
DLL Programmer’s Guide for TNS/R Systems—522203-002
xiii
Notation for Messages
a blank line. This spacing distinguishes items in a continuation line from items in a
vertical list of selections. For example:
ALTER [ / OUT file-spec / ] LINE
[ , attribute-spec ]…
!i and !o. In procedure calls, the !i notation follows an input parameter (one that passes data
to the called procedure); the !o notation follows an output parameter (one that returns
data to the calling program). For example:
CALL CHECKRESIZESEGMENT ( segment-id !i
, error ) ; !o
!i,o. In procedure calls, the !i,o notation follows an input/output parameter (one that both
passes data to the called procedure and returns data to the calling program). For
example:
error := COMPRESSEDIT ( filenum ) ; !i,o
!i:i. In procedure calls, in TAL or PTAL, the !i:i notation follows an input string parameter
that has a corresponding parameter specifying the length of the string in bytes. For
example:
error := FILENAME_COMPARE_ ( filename1:length !i:i
, filename2:length ) ; !i:i
Note that some interfaces count the pair as a single parameter for error-reporting
purposes, even though they constitute two separate parameters, and must be so
expressed in C or C++.
!o:i. In procedure calls, in TAL or PTAL, the !o:i notation follows an output buffer parameter
that has a corresponding input parameter specifying the maximum length of the output
buffer in bytes. For example:
error := FILE_GETINFO_ ( filenum !i
, [ filename:maxlen ] ) ; !o:i
Note that some interfaces count the pair as a single parameter for error-reporting
purposes, even though they constitute two separate parameters, and must be so
expressed in C or C++.
Notation for Messages
This list summarizes the notation conventions for the presentation of displayed
messages in this manual.
Bold Text. Bold text in an example indicates user input typed at the terminal. For example:
ENTER RUN CODE
?123
CODE RECEIVED: 123.00