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

Section 18
SAR$ WRITE
18.1. WRITE Function/PLUS Interface
The SAR$ WRITE function writes symbolic images to SDF files, SDF elements, and
symbiont files (PRINT$, PUNCH$, alternate PRINT$, and alternate PUNCH$). If an SDF
element is written to, the element is added to the program file table of contents when
the WRITE operation is completed (by calling SAR_CLOSE_OUTPUT).
The SAR$ WRITE function procedures can be called from PLUS. These procedures are
• SAR_OPEN_OUTPUT
• SAR_WRITE
• SAR_WRITE_CONTROL
• SAR_CLOSE_OUTPUT
All SAR$ data structure definitions and procedure calls are contained in definition
elements. These elements are obtained with the PLUS COPY statement.
Empty symbiont output files may not be created by simply calling SAR_OPEN_OUTPUT
followed by SAR_CLOSE_OUTPUT. An empty symbiont file may be created by setting
IMAGE_CONTROL_WIDTH to a nonzero value when calling SAR_OPEN_OUTPUT,
followed by a call to SAR_CLOSE_OUTPUT. This will cause a print control image to be
generated, which will open the output file. If IMAGE_CONTROL_WIDTH is zero when
creating an "empty" symbiont file, an error will occur during SAR_CLOSE_OUTPUT.
18.1.1. WRITE Packet Data Structure Description
The SAR$ WRITE function requires a WRITE packet data structure for the
SAR_OPEN_OUTPUT, SAR_WRITE, SAR_WRITE_CONTROL, and
SAR_CLOSE_OUTPUT procedure calls.
The type definition for this data structure is contained in the element SAR$WPKTD in the
SYSLIB file (SYS$LIB$*SYSLIB) or SYS$*RLIB$. It is obtained with the COPY
statement. The identifier for the WRITE packet data structure type is
SAR_WRITE_PACKET.
7833 1733–004 18–1