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

SAR$ WRITE
In this example, the COPY statement obtains the SAR$ definitions for the buffers and
tables, WRITE packet, WRITE procedure, and file information packet.
The SAR$ data structures for the WRITE function are declared by using the definitions
contained in element SAR$DEFN, SAR$WPKTD, and SAR$FILEPKTD.
The WRITE packet is initialized by assigning appropriate values to all necessary fields.
All other WRITE packet fields take the default values if the WRITE packet is zero-filled.
The SAR_WRITE_PACKET_CURRENT_VERSION constant is defined in the SAR$WPKTD
element, and the buffer length constants are defined in the SAR$DEFN element.
The WRITE function is initialized by calling the SAR_OPEN_OUTPUT procedure, passing
the WRITE packet address as a parameter. If the CALL_STATUS field of the WRITE
packet is not status S'Normal', the error is processed. The SAR_WRITE procedure is
called to write each SDF image out to the file or element described in the file information
packet.
When all images are written out, the SAR_CLOSE_OUTPUT procedure is called. This
procedure writes an end-of-file record, and if the output is to an element, adds the
element to the program file table of contents.
18.1.4. Status Lists for PLUS WRITE Procedures
The WRITE procedure call status codes listed in Table 18–3 may be returned to the
calling program in the CALL_STATUS field of the WRITE packet. These CALL_STATUS
codes are for SAR_WRITE_PACKET_CURRENT_VERSION = 2 and above. A list of all call
status codes is available as WRITE_CALL_STATUS_LIST, an 18-bit status data entity
defined in the element SAR$WPKTD.
Table 18–3. SAR$: WRITE Procedure CALL_STATUS Codes
Octal Code Status
0 Normal return from SAR$.
01 An outdated WRITE packet version is being used.
02 An invalid WRITE packet version is being used.
03 The value for IMAGE_BUFFER_ADDRESS is NULL; an address must be
given for the output image buffer.
04 The IMAGE_BUFFER_WORD_LENGTH is zero; a length must be given for
the output image buffer.
05 The value for OUTPUT_FILE_INFO_PKT_ADDRESS is NULL; a file
information packet must be given for this output file type.
06 An invalid value is specified for OUTPUT_FILE_TYPE.
07 An invalid value is specified for OUTPUT_LINE_NUMBER_TYPE.
010 An invalid value is specified for UNTRANSLATE_MODE.
7833 1733–004 18–19