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

19.1.3.2. SAR_ATREAD Procedure Call
SAR$ ATREAD
The SAR_ATREAD procedure constructs an image from the output text and output
attributes, writes the image to the current output stream, reads an image from the
current input stream, and returns the character text and attributes of the image to the
calling program.
Initial Conditions
The calling program sets the following parameters in the packet to appropriate values
before calling SAR_ATREAD:
• Required parameters (described in 19.1.1.1)
OUTPUT_TEXT_BUFFER_ADDRESS
OUTPUT_TEXT_BUFFER_BYTE_LENGTH
OUTPUT_ATTRIBUTE_TABLE_ADDRESS
OUTPUT_ATTRIBUTE_TABLE_WORD_LENGTH
INPUT_TEXT_BUFFER_ADDRESS
INPUT_TEXT_BUFFER_BYTE_LENGTH
INPUT_ATTRIBUTE_TABLE_ADDRESS
INPUT_ATTRIBUTE_TABLE_WORD_LENGTH
• Optional parameters (described in 19.1.1.2)
OUTPUT_CHARACTER_TYPE
OUTPUT_IMAGE_LINE_SPACING
Calling Format
PROCEDURE SAR_ATREAD
(ATREAD_PACKET_ADDRESS: WORD MACHINE POINTER)
IMPORTED (‘SAR$ATR$PG’);
Returns
SAR_ATREAD returns the calling status in the ATREAD packet field CALL_STATUS.
If the status is S'Normal', then the call was successful. Following is the information
returned by SAR$ to the caller:
• Character text
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.
• Character type
The character set type of the image read is returned in the field
INPUT_CHARACTER_TYPE. The octal code of the character set type is returned in
the field INPUT_CHARACTER_CODE.
7833 1733–004 19–9