PEXGetPredefinedEntries(3) — Subroutines

Name

PEXGetPredefinedEntries - Get Lookup Table Predefined Indices

Synopsis

Status PEXGetPredefinedEntries(Display ∗display, Drawable drawable, int table_type, unsigned int start, unsigned int count, PEXPointer ∗entries_return)

Arguments

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

drawableThe resource identifier of a drawable.

table_typeThe type of lookup table (see the Description).

startThe index of the first predefined entry to be returned.

countThe number of predefined entries requested.

entries_return
Returns an array of predefined table entries.

Returns

Zero if unsuccessful, non-zero otherwise.

Description

This function returns the predefined entries for the specified lookup table. The type must be one of the following:

PEXLUTColorApprox
PEXLUTColor
PEXLUTDepthCue
PEXLUTEdgeBundle
PEXLUTInteriorBundle
PEXLUTLight
PEXLUTLineBundle
PEXLUTMarkerBundle
PEXLUTPattern
PEXLUTTextBundle
PEXLUTTextFont
PEXLUTView

Predefined entries are those automatically filled with valid data when a lookup table is created. The query is conducted based on the assumption that the lookup table would be used on drawables with the same root and depth as the specified drawable. The function returns at most the specified number of entries, starting with the specified entry index. The number of entries requested can not be larger than the number of predefined entries. Call PEXGetTableInfo to determine the number of predefined entries.

Entries in the returned list depend on the type specified. See PEXSetTableEntries for the structure types.

PEXlib allocates the memory for the returned table entries. PEXFreeTableEntries should be called to deallocate the memory.

Data Structures

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

Errors

BadDrawableThe specified drawable resource identifier is invalid.

BadMatchThe specified drawable is unsupported.

BadValueThe specified table type is invalid or unsupported, start is less than the minimum predefined entry, the sum of start and count is greater than the maximum predefined entry, or index 0 is not valid for the specified table type.

BadPEXLookupTable
The specified table type is unsupported.

Museum