PEXGetTableEntry(3) — Subroutines

Name

PEXGetTableEntry - Get Lookup Table Entry

Synopsis

PEXPointer PEXGetTableEntry(Display ∗display, PEXLookupTable table, unsigned int index, int value_type, int ∗status_return, int ∗table_type_return)

Arguments

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

tableThe resource identifier of the lookup table.

indexThe index of the entry to be returned from the lookup table.

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

status_return
Returns the entry status, either PEXDefinedEntry if the specified lookup table entry is defined or PEXDefaultEntry if it is undefined.

table_type_return
Returns the type of table.

Returns

A pointer to the lookup table entry; a null pointer if unsuccessful.

Description

This function returns a single entry from the specified lookup table. If the specified lookup table entry is defined, the defined entry is returned. If the specified lookup table entry is not defined, the default entry for that type of table is returned.

The type of structure returned depends on the specified 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 memory for the returned entry. 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.

BadValueIndex 0 is invalid for the specified table type.

Museum