.\" @(#)PEXGetOCAddr.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetOCAddr 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetOCAddr - Get Address For Encoded Output Commands
.SH SYNTAX
.HP
char *PEXGetOCAddr\^(\^Display *\fIdisplay\fP\^, int \fIlength\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIlength\fP 1i
The number of bytes of data to be written by the application.
.SH RETURNS
.LP
A pointer to memory where the application can write output command data; a null
pointer if unsuccessful.
.SH DESCRIPTION
.\" indexing
.IX PEXGetOCAddr
.IX "Output Commands" PEXGetOCAddr
.LP
This function returns a memory address to the specified number of bytes in
the transport buffer where the application can write data.
.LP
The pointer returned is valid only until the next
.B PEXGetOCAddr
or
.BR PEXCopyBytesToOC (3)
is called.
.LP
An attempt to request more bytes than remaining in the transport buffer, or
more bytes than returned by
.BR PEXGetOCAddrMaxSize (3) ,
will result in an unsuccessful return value.
.LP
.BR PEXStartOCs (3)
must be called prior to this.
.LP
\fIDO NOT\fP attempt to deallocate or free memory at the address returned
by this function.
.SH ERRORS
None
.SH SEE ALSO
.LP
.nf
.BR PEXStartOCs (3)
.BR PEXFinishOCs (3)
.BR PEXCopyBytesToOC (3)
.BR PEXGetOCAddrMaxSize (3)
.fi