PEXEscapeWithReply - PEX Escape With Reply (5.1)


Synopsis

 
   char *PEXEscapeWithReply(
        Display *display,
        unsigned long escape_id,
        int length,
        char *escape_data,
        unsigned long *reply_length_return
   )
 

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.

reply_length_return
Returns the length, in bytes, of the reply data.

Returns

A pointer to the escape reply data; a null pointer if unsuccessful.

Description

Invoke PEXEscapeWithReply to access implementation-specific functionality. This request is similar to PEXEscape except it has return data.

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.

The reply data is returned in memory allocated by PEXlib. Invoke XFree to deallocate the memory. The reply data consists of all the data in the protocol reply packet, starting with the 13th byte of the protocol reply packet.

There are no standard PEX escapes with replies.

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 does not generate a reply.

See Also

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