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

SAR$ WRITE
18.1.3.2. SAR_WRITE Procedure Call
The SAR_WRITE procedure writes images to the output file or element. Each call to
SAR_WRITE writes out one image. The calling program must supply the character text
of the image in the text buffer and the attributes for the text (if any) in the attribute table.
SAR_WRITE combines the text and attributes into the proper format and writes out the
image.
Initial Conditions
The calling program sets the following parameters in the WRITE packet to appropriate
values before calling SAR_WRITE:
• Required parameters (described in 18.1.1.1)
TEXT_BUFFER_ADDRESS
TEXT_BUFFER_BYTE_LENGTH
ATTRIBUTE_TABLE_ADDRESS
ATTRIBUTE_TABLE_WORD_LENGTH
• Optional parameters (described in 18.1.1.2)
OUTPUT_RECORD_TYPE
INPUT_TEXT_CHARACTER_TYPE
OUTPUT_IMAGE_LINE_SPACING
LINE_NUMBER_INTEGER_PART
LINE_NUMBER_FRACTIONAL_PART(1:4)
Calling Format
PROCEDURE SAR_WRITE
(WRITE_PACKET_ADDRESS: WORD MACHINE POINTER)
IMPORTED ('SAR$WRITE$PG');
Returns
SAR_WRITE returns the calling status in the WRITE packet field CALL_STATUS. If the
status is S'Normal', then the write was successful. The following fields of the WRITE
packet contain information returned by SAR$ to the calling program:
IMAGE_BYTE_LENGTH
IMAGE_ADDRESS_SECTOR
IMAGE_ADDRESS_WORD_OFFSET
These parameters are described in 18.1.1.3.
If the status returned from SAR_WRITE is not S'Normal', then an error has occurred and
CALL_STATUS contains the status code. See 18.1.4 for a list of WRITE function status
codes.
18–14 7833 1733–004