Name

PEXEscape - PEX Escape

Synopsis

void PEXEscape(Display ∗display, unsigned long escape_id, int length, char ∗escape_data)

Arguments

displayA pointer to a display structure returned by a successful XOpenDisplay call. 

escape_idThe escape identifier. 

lengthThe length, in bytes, of data for the escape request. 

escape_dataA pointer to data for the escape request. 

Returns

None

Description

PEXEscape has an implementation-dependent effect.  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.

There is one standard PEX escape, see below. 

If the specified escape identifier is not supported, a value error is generated. 

Standard PEX Escape:

PEXEscapeSetEchoColor is an escape to set the echo color for use by a renderer when echoing primitives. PEXEscapeSetEchoColor is the name of the escape identifier and is passed as the escape identifier to PEXEscape. The escape data for PEXEscapeSetEchoColor consists of a renderer resource identifier (XID) followed by a color specifier (PEXColorSpecifier). See the PEXSetEchoColor function for further description of this standard escape.

Errors

Escape-dependent
See documentation provided with the individual PEX server implementation.

BadValueThe specified escape identifier is unsupported. 

See Also

PEXEscapeWithReply, PEXSetEchoColor