.\" @(#)PEXGetTableInfo.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetTableInfo 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetTableInfo - Get Lookup Table Information
.SH SYNTAX
.HP
Status PEXGetTableInfo\^(\^Display *\fIdisplay\fP\^, Drawable \fIdrawable\fP\^,
int \fItable_type\fP\^, PEXTableInfo *\fIinfo_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 \fIinfo_return\fP 1i
Returns the lookup table information.
.SH RETURNS
.LP
Zero if unsuccessful, non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXGetTableInfo
.IX "Lookup Table" PEXGetTableInfo
.LP
This function returns information about the specified type of
lookup table.
The type of lookup table 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
The returned information is based on the assumption that
the lookup table would be used on drawables with the same root
and depth as the specified drawable.  The returned information includes the
number of predefined table entries, the number of definable table
entries, and the indices of the predefined minimum and maximum entries.
Predefined entries are contiguous.  The number of definable table entries
includes the number of predefined entries since predefined table entries can
be redefined by the application.  All entries between the predefined minimum
and maximum values are guaranteed to be defined initially (i.e. predefined
entries have contiguous indices).
.SH DATA STRUCTURES
.LP
.nf
typedef struct {
	unsigned short		definable_entries;
	unsigned short		predefined_count;
	unsigned short		predefined_min;
	unsigned short		predefined_max;
.br
} PEXTableInfo;
.fi
.SH ERRORS
.TP
.SB BadDrawable
The specified drawable resource identifier is invalid.
.TP
.SB BadMatch
The specified drawable is unsupported.
.TP
.SB BadPEXLookupTable
The specified table type is unsupported.
.TP
.SB BadValue
The specified table type is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateLookupTable (3)
.fi