Name

PEXEscapeWithReply - PEX Escape With Reply

Synopsis

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

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. 

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

PEXEscapeWithReply has an implementation-dependent effect.  It is similar to PEXEscape 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.

There are no standard PEX escapes with replies. 

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

The reply data is returned in memory allocated by PEXlib.  XFree should be called to deallocate the memory.

Errors

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

BadValueThe specified escape identifier is unsupported. 

See Also

PEXEscape