.\" @(#)PEXStartOCs.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXStartOCs 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXStartOCs - Start Encoded Output Commands
.SH SYNTAX
.HP
Status PEXStartOCs\^(\^Display *\fIdisplay\fP\^, XID \fIresource_id\fP\^, PEXOCRequestType \fIreq_type\fP\^, int \fIfloat_format\fP\^, int \fIoc_count\fP\^, int \fIword_count\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIresource_id\fP 1i
The resource identifier of the renderer or structure.
.IP \fIreq_type\fP 1i
The request type for the output command (
.B PEXOCRender,
.B PEXOCStore,
.B PEXOCRenderSingle
or
.B PEXOCStoreSingle
).
.IP \fIfloat_format\fP 1i
The floating point format of the output command data (
.B PEXIEEE_754_32,
.B PEXDEC_F_Floating,
.B PEXIEEE_754_64,
.B PEXDEC_D_Floating
).
.IP \fIoc_count\fP 1i
The number of output commands to be sent.
.IP \fIword_count\fP 1i
The number of four-byte words of data for the total size of the output commands.
.SH RETURNS
.LP
Zero is unsuccessful, non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXStartOCs
.LP
This function locks the display.
Only
.B PEXCopyBytesToOC
or
.B PEXGetOCAddr
may be called
between pairs of
.B PEXStartOCs
and
.B PEXFinishOCs.
Do not call anything else that may lock the display as this will result in
deadlock.
.LP
The first output command is guaranteed to start on a four-byte boundary.
Output command data may be copied into the transport buffer by calling
.B PEXCopyBytesToOC.
Output command data may be written directly by the application by calling
.B PEXGetOCAddr
to get a pointer to memory in the transport buffer.
.LP
.B PEXFinishOCs
must be called after all the data has been specified.
.LP
The application is responsible for writing valid protocol and the correct numberof words requested.
.LP
If the requested number of words is too large for the display connection
(each server has a maximum request size), the function will return
unsuccessfully.  If this occurs, and the number of output commands was
greater than one, the application should try specifying the data for a
single output command at a time.
If the size of a single output command is too large for the display connection,
the function will return unsuccessfully.
.SH ERRORS
.TP
.SB BadPEXFloatingPointFormat
The specified floating point format is invalid or unsupported.
.TP
.SB BadPEXOutputCommand
The output command contains an invalid value.
.TP
.SB BadPEXRenderer
The specified renderer resource identifier is invalid.
.TP
.SB BadPEXStructure
The specified structure resource identifier is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXFinishOCs (3)
.BR PEXCopyBytesToOC (3)
.BR PEXGetOCAddr (3)
.fi