PEXFetchElements - Fetch Elements (5.0)

Synopsis

 
   Status PEXFetchElements(
          Display *display,
          PEXStructure structure,
          int whence1,
          long offset1,
          int whence2,
          long offset2,
          int float_format,
          unsigned long *count_return,
          unsigned long *length_return,
          char **ocs_return
   )

Arguments

display: A pointer to a display structure returned by a successful XOpenDisplay call.
structure: The resource identifier of the structure.
whence1: A value specifying, with offset1, the first limit of the range of elements to be fetched (PEXBeginning, PEXCurrent or PEXEnd).
offset1: The offset from whence1 denoting the first limit of the range of elements to be fetched.
whence2: A value specifying, with offset2, the second limit of the range of elements to be fetched (PEXBeginning, PEXCurrent or PEXEnd).
offset2: The offset from whence2 denoting the second limit of the range of elements to be fetched.
float_format: The floating-point format to use when formatting the output commands to be fetched (PEXIEEE_754_32, PEXDEC_F_Floating, PEXIEEE_754_64 or PEXDEC_D_Floating).
count_return: Returns the number of output commands returned.
length_return: Returns the length, in bytes, of the output commands fetched.
ocs_return: Returns a pointer to protocol-formatted output commands (structure elements).

Returns

Zero if unsuccessful; non-zero otherwise.

Description

Invoke PEXFetchElements to get a range of structure elements from the specified structure.

If either computed offset is less than zero, then it is set to zero before getting the structure elements. If either computed offset is greater than the number of elements in the structure, then it is set to the offset of the last element in the structure. The element pointer attribute of structure is not affected by this command. No information is returned for inquiries on element offset zero.

A null pointer is returned if the implementation does not support the requested floating-point format.

Any text or annotation text output commands returned are formatted as encoded text or encoded annotation text.

PEXlib allocates memory for the return value. Invoke XFree to deallocate the memory.

Errors