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

SAR$ ATREAD
19.1.3. ATREAD Procedures Called from PLUS
The procedures for the ATREAD function are
• SAR_INITIALIZE_ATREAD
• SAR_ATREAD
• SAR_RESTORE_ATREAD
The procedure declarations for SAR_INITIALIZE_ATREAD, SAR_ATREAD, and
SAR_RESTORE_ATREAD are contained in the element SAR$ATR$DG in the SYSLIB file
SYS$LIB$*SYSLIB. This element may be obtained with the COPY statement.
SAR$ATR$DG contains all three procedure declarations. All of the ATREAD procedure
modules are compiled with the G option using the IBJ$ calling sequence.
19.1.3.1. SAR_INITIALIZE_ATREAD Procedure Call
The ATREAD packet data structure must be initialized before calling SAR_ATREAD. The
SAR_INITIALIZE_ATREAD procedure performs the ATREAD packet initialization.
Initial Conditions
The calling program sets the following parameters in the ATREAD packet to appropriate
values before calling SAR_INITIALIZE_ATREAD:
• Required parameters (described in 19.1.1.1)
PACKET_VERSION
IMAGE_BUFFER_ADDRESS
IMAGE_BUFFER_WORD_LENGTH
• Optional parameters (described in 19.1.1.2)
INPUT_SELECT_LIST_ADDRESS
NPUT_SELECT_LIST_BYTE_LENGTH
NPUT_REQUEST_TYPE
PRINT_CONTROL_WIDTH
Note: The caller should zero-fill the ATREAD packet before placing any parameters in
the packet.
Calling Format
PROCEDURE SAR_INITIALIZE_ATREAD
(ATREAD_PACKET_ADDRESS: WORD MACHINE POINTER)
IMPORTED ('SAR$INATR$PG');
Returns
SAR_INITIALIZE_ATREAD returns the initialization status in the packet in CALL_STATUS.
If the status is S'Normal', the initialization of the ATREAD packet is successful.
Otherwise an error has occurred and CALL_STATUS contains the status code.
See 19.1.4 for the ATREAD function status code lists.
19–8 7833 1733–004