PEXEscape - PEX Escape (5.1)


Synopsis

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

Arguments

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

escape_id
The escape identifier.

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

escape_data
A pointer to data for the escape request.

Returns

None.

Description

Invoke PEXEscape to access implementation-specific functionality.

This request invokes the PEX-defined or vendor-specific escape specified by escape_id. The complete interface and behavior for each specified escape identifier should be specified by the individual PEX implementation.

PEXlib defines one standard PEX Escape:

PEXEscapeSetEchoColor -
sets 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. This escape is defined for compatibility with PEX 5.1. Starting with PEX 5.2, this function is implemented with the echo color renderer attribute.

Errors

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

BadValue
The specified escape identifier is unsupported or is the identifier of an escape that generates a reply.

See Also

For a list of PEX Escape functions and related topics, see PEX Escapes.