.\" @(#)PEXGetPredefinedEntries.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetPredefinedEntries 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetPredefinedEntries - Get Lookup Table Predefined Indices
.SH SYNTAX
.HP
Status PEXGetPredefinedEntries\^(\^Display *\fIdisplay\fP\^, Drawable \fIdrawable\fP\^, int \fItable_type\fP\^, unsigned int \fIstart\fP\^, unsigned int \fIcount\fP\^, PEXPointer *\fIentries_return\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIdrawable\fP 1i
The resource identifier of a drawable.
.IP \fItable_type\fP 1i
The type of lookup table (see the Description).
.IP \fIstart\fP 1i
The index of the first predefined entry to be returned.
.IP \fIcount\fP 1i
The number of predefined entries requested.
.IP \fIentries_return\fP 1i
Returns an array of predefined table entries.
.SH RETURNS
.LP
Zero if unsuccessful, non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXGetPredefinedEntries
.IX "Lookup Table" PEXGetPredefinedEntries
.LP
This function returns the predefined entries for the specified lookup
table.
The type must be one of the following:
.LP
.nf
.RS
.B PEXLUTColor
.B PEXLUTColorApprox
.B PEXLUTDepthCue
.B PEXLUTEdgeBundle
.B PEXLUTInteriorBundle
.B PEXLUTLight
.B PEXLUTLineBundle
.B PEXLUTMarkerBundle
.B PEXLUTPattern
.B PEXLUTTextBundle
.B PEXLUTTextFont
.B PEXLUTView
.RE
.fi
.LP
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
.BR PEXGetTableInfo (3)
to determine the number of predefined entries.
.LP
Entries in the returned list depend on the type specified.
See
.BR PEXSetTableEntries (3)
for the structure types.
.LP
PEXlib allocates the memory for the returned table entries.
.BR PEXFreeTableEntries (3)
should be called to deallocate the memory.
.SH DATA STRUCTURES
.LP
.nf
#if NeedFunctionPrototypes
typedef	void	*PEXPointer;
#else
typedef	char	*PEXPointer;
#endif
.fi
.SH ERRORS
.TP
.SB BadDrawable
The specified drawable resource identifier is invalid.
.TP
.SB BadMatch
The specified drawable is unsupported.
.TP
.SB BadValue
The 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.
.TP
.SB BadPEXLookupTable
The specified table type is unsupported.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateLookupTable (3)
.BR PEXGetTableInfo (3)
.BR PEXGetDefinedIndices (3)
.BR PEXGetTableEntry (3)
.BR PEXGetTableEntries (3)
.BR PEXSetTableEntries (3)
.fi