(SYSLIB) Programming Reference Manual - Public Support Login ...

Calling Format
PROCEDURE SAR_COM(COM_PACKET_ADDRESS: WORD MACHINE POINTER)
IMPORTED (‘SAR$COM$PG’);
SAR$ COM
Returns
SAR_COM returns the calling status in the COM packet field CALL_STATUS. If the
status is S'Normal', then the call was successful. The following information is returned
by SAR$ to the calling program:
• Character text
If operator input was solicited, the address of the character text and the length in
9-bit bytes (characters) are returned in the fields INPUT_TEXT_BUFFER_ADDRESS
and BYTE_LENGTH_OF_INPUT_TEXT, respectively. The character set type of the
image read is the same as the output image character set type.
• Attributes
If operator input was solicited, the address of the input attribute table and the
number of entries are returned in the fields INPUT_ATTRIBUTE_TABLE_ADDRESS
and NUMBER_OF_INPUT ATTRIBUTES, respectively.
If the status returned from SAR_COM is not S'Normal' or S'End_of_file', then an error
has occurred and CALL_STATUS contains the status code. See 20.1.4 for a list of COM
function status codes.
20.1.4. Status Lists for PLUS COM Procedure
The COM procedure call status codes listed in Table 20–3 may be returned to the calling
program in the CALL_STATUS field of the COM packet. These CALL_STATUS codes are
for SAR_COM_PACKET_CURRENT_VERSION = 1 and above. A list of all call status
codes is available as COM_CALL_STATUS_LIST, an 18-bit status data entity defined in
the element SAR$COMPKTD.
Table 20–3. SAR$: COM Procedure CALL_STATUS Codes
Octal Code Status
0 Normal return from the SAR$ COM procedure.
01 An outdated SAR$ COM packet version is being used.
02 An invalid SAR$ COM packet version is being used.
03 The value for IMAGE_BUFFER_ADDRESS is NULL; an address must be
given for the input image buffer.
04 The IMAGE_BUFFER_WORD_LENGTH is zero; a length must be given for
the input image buffer.
05 An invalid value is specified for the INPUT_REQUEST_TYPE field.
7833 1733–004 20–9