.\" @(#)PEXEscapeWithReply.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXEscapeWithReply 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXEscapeWithReply - PEX Escape With Reply
.SH SYNTAX
.HP
char *PEXEscapeWithReply\^(\^Display *\fIdisplay\fP\^, unsigned long \fIescape_id\fP\^, int \fIlength\fP\^, char *\fIescape_data\fP\^, unsigned long *\fIreply_length_return\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIescape_id\fP 1i
The escape identifier.
.IP \fIlength\fP 1i
The length, in bytes, of data for the escape request.
.IP \fIescape_data\fP 1i
A pointer to data for the escape request.
.IP \fIreply_length_return\fP 1i
Returns the length, in bytes, of the reply data.
.SH RETURNS
A pointer to the escape reply data; a null pointer if unsuccessful.
.SH DESCRIPTION
.\" indexing
.IX PEXEscapeWithReply
.IX "Escapes" "PEXEscapeWithReply"
.LP
.B PEXEscapeWithReply
has an implementation-dependent effect.  It is similar to
.BR PEXEscape (3)
except it has return data.
It is provided as a way for
implementation-specific functionality to be accessed.  The complete
interface and behavior for each specified escape identifier should be
specified by the individual PEX server implementation.
.LP
If the specified escape identifier is not supported,
a value error is generated.
The table below lists the supported escape identifiers.
.LP
The reply data is returned in memory allocated by PEXlib.
.B XFree
should be called to deallocate the memory.
.\"@
.\" start equation_nroff_version
.if t .ig xx
.sp
.nf
PEXSunEscIdGetMarkerDescr       Get marker descriptions
PEXSunEscIdGetExtRendAttr       Get extended renderer attributes
PEXSunEscIdGetExtRendAttrDyn    Get extended renderer dynamics
ES_ESCAPE_SWAPBUFFERCONTENT     Inquire update action during buffer swap
.sp
.fi
.xx
.\"@
.\" start equation_troff_version
.if n .ig yy
.LP
.TS
center, box;
lfB lfB
l l.
Escape Identifier	Description
_
PEXSunEscIdGetMarkerDescr	Get marker descriptions
PEXSunEscIdGetExtRendAttr	Get extended renderer attributes 
PEXSunEscIdGetExtRendAttrDyn	Get extended renderer dynamics
ES_ESCAPE_SWAPBUFFERCONTENT	Inquire update action during buffer swap
.TE
.yy
.SH ERRORS
.TP
.SB Escape-dependent
See documentation provided with the individual PEX server implementation.
.TP
.SB BadValue
The specified escape identifier is unsupported.
.SH SEE ALSO
.LP
.nf
.BR PEXEscape (3)
.fi