PEXGetTableEntries(3) — Subroutines

Name

PEXGetTableEntries - Get Lookup Table Entries

Synopsis

Status PEXGetTableEntries(Display ∗display, PEXLookupTable table, unsigned int start, unsigned int count, int value_type, int ∗table_type_return, PEXPointer ∗entries_return)

Arguments

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

tableThe resource identifier of the lookup table from which the table entries are to be obtained.

startThe index of the first lookup table entry to be returned.

countThe number of entries requested.

value_typeThe type of values to return (PEXSetValue or PEXRealizedValue).

table_type_return
Returns the type of table.

entries_return
Returns an array of table entries.

Returns

Zero if unsuccessful, non-zero otherwise.

Description

This function returns the values associated with a range of contiguous table indices, starting at the specified entry index. If a table entry in the requested range is not defined, the default entry for a table of this type is returned.

The type of entries in the returned list depend on the returned table type. See PEXSetTableEntries for the structure types.

If the requested value type is PEXSetValue, the values returned will be those originally set in the table entry. If the requested value type is PEXRealizedValue, the values returned will be those 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 entries. PEXFreeTableEntries should be called to deallocate the memory.

Data Structures

typedef XID PEXLookupTable;
#if NeedFunctionPrototypes
typedef void ∗PEXPointer;
#else
typedef char ∗PEXPointer;
#endif

Errors

BadPEXLookupTable
The specified lookup table resource identifier is invalid, or the table type is unsupported.

BadValueThe sum of start and count is too large, or index 0 is invalid for the specified table type.

Museum