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

19.1.4. SAR_RESTORE_ATREAD Procedure Call
SAR$ ATREAD
The SAR_RESTORE_ATREAD procedure restores the caller's environment, if it was
changed by SAR_ATREAD. Specifically, if SAR_ATREAD changed the print line width,
SAR_RESTORE_ATREAD will reset the print line width to the device default.
There are no required packet parameters for the SAR_RESTORE_ATREAD call.
However, SAR_RESTORE_ATREAD expects that a prior call to the
SAR_INITIALIZE_ATREAD routine was made.
Calling Format
PROCEDURE SAR_RESTORE_ATREAD
(ATREAD_PACKET_ADDRESS: WORD MACHINE POINTER)
IMPORTED (‘SAR$RSATR$PG’);
Returns
SAR_RESTORE_ATREAD returns the calling status in the ATREAD packet field,
CALL_STATUS. If the status is S'Normal', then the call was successful.
If the status returned from SAR_RESTORE_ATREAD is not S'Normal', then an error has
occurred, and CALL_STATUS contains the status code. See 19.1.5 for a list of ATREAD
function status codes.
19.1.5. Status Lists for PLUS ATREAD Procedures
The ATREAD procedure call status codes listed in Table 19–3 may be returned to the
calling program in the CALL_STATUS field of the ATREAD packet. These CALL_STATUS
codes are for SAR_ATREAD_PACKET_CURRENT_VERSION = 1 and above. A list of all
call status codes is available as ATREAD_CALL_STATUS_LIST, an 18-bit status data
entity defined in the element SAR$ATRPKTD.
Table 19–3. SAR$: ATREAD Procedure CALL_STATUS Codes
Octal Code Status
0 Normal return from the ATREAD procedure.
01 End-of-file condition reached by SAR_ATREAD.
02 An I/O error has occurred in an ATREAD procedure. See the
IO_STATUS_CODE field for the status code.
03 An outdated ATREAD packet version is being used.
04 An invalid ATREAD packet version is being used.
05 The ATREAD packet is not initialized; a call to SAR_INITIALIZE_ATREAD
must be made before calling SAR_ATREAD.
06 The value for IMAGE_BUFFER_ADDRESS is NULL; an address must be
given for the input image buffer.
7833 1733–004 19–11