PEXGetTableValues - Get Table Values (5.2)

Synopsis 

 
  PEXPointer PEXGetTableValues(
       Display *display,
       PEXLookupTable table,
       int value_type,
       unsigned int index,
       unsigned long mask,
       int *table_type_return
   )

Arguments

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

table
The resource identifier of the lookup table.

value_type
The type of values to return (PEXSetValue or PEXRealizedValue).

index
The index of the table entry from which to fetch the values.

mask
The mask indicating which table entry values are to be returned.

table_type_return
Returns the type of table.

Returns

Zero if unsuccessful; otherwise a pointer to a data structure mapping the returned table entry values, depending on table type (see PEXLookupTable). See Table Types, Availability, and Definitions for a description.

Description

Invoke PEXGetTableValues to obtain the specified values from the lookup table entry index in the specified lookup table.

If the implementation does not define the specified table entry you request, then this function returns the values for the default entry for a table of the requested type structure types.

PEXlib defines the following value types:

PEXSetValue -
returns the values originally set in the table entry.

PEXRealizedValue -
returns the values actually used during rendering (i.e., the values used if the specified entry value can not be exactly matched).

PEXlib allocates the memory for the returned entry. Invoke PEXFreeTableValues to deallocate the memory.

Errors

BadPEXLookupTable
The specified lookup table resource identifier is invalid.

BadValue
Index 0 is invalid for the specified table type.

See Also

For an overview, see Lookup Tables.