Name

PEXGetOCAddr - Get Address For Encoded Output Commands

Synopsis

char ∗PEXGetOCAddr(Display ∗display, int length)

Arguments

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

lengthThe number of bytes of data to be written by the application. 

Returns

A pointer to memory where the application can write output command data; a null pointer if unsuccessful. 

Description

This function returns a memory address to the specified number of bytes in the transport buffer where the application can write data. 

The pointer returned is valid only until the next PEXGetOCAddr or PEXCopyBytesToOC is called.

An attempt to request more bytes than remaining in the transport buffer, or more bytes than returned by PEXGetOCAddrMaxSize, will result in an unsuccessful return value.

PEXStartOCs must be called prior to this.

DO NOT attempt to deallocate or free memory at the address returned by this function. 

Errors

None

See Also

PEXStartOCs, PEXFinishOCs, PEXCopyBytesToOC,
PEXGetOCAddrMaxSize