.\" @(#)PEXGetTableEntry.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetTableEntry 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetTableEntry - Get Lookup Table Entry
.SH SYNTAX
.HP
PEXPointer PEXGetTableEntry\^(\^Display *\fIdisplay\fP\^, PEXLookupTable \fItable\fP\^, unsigned int \fIindex\fP\^, int \fIvalue_type\fP\^, int *\fIstatus_return\fP\^, int *\fItable_type_return\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fItable\fP 1i
The resource identifier of the lookup table.
.IP \fIindex\fP 1i
The index of the entry to be returned from the lookup table.
.IP \fIvalue_type\fP 1i
The type of values to return (
.B PEXSetValue
or
.B PEXRealizedValue
).
.IP \fIstatus_return\fP 1i
Returns the entry status, either
.B PEXDefinedEntry
if the specified lookup table entry is defined or
.B PEXDefaultEntry
if it is undefined.
.IP \fItable_type_return\fP 1i
Returns the type of table.
.SH RETURNS
.LP
A pointer to the lookup table entry; a null pointer if unsuccessful.
.SH DESCRIPTION
.\" indexing
.IX PEXGetTableEntry
.IX "Lookup Table" PEXGetTableEntry
.LP
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.
.LP
The type of structure returned depends on the specified type.
See
.BR PEXSetTableEntries (3)
for the structure types.
.LP
If the requested value type is
.B PEXSetValue,
the values returned will be those originally set in the table entry.
If the requested value type is
.B 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).
.LP
PEXlib allocates memory for the returned entry.
.BR PEXFreeTableEntries (3)
should be called to deallocate the memory.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXLookupTable;
.sp
#if NeedFunctionPrototypes
typedef	void	*PEXPointer;
#else
typedef	char	*PEXPointer;
#endif
.fi
.SH ERRORS
.TP
.SB BadPEXLookupTable
The specified lookup table resource identifier is invalid, or the table type is
unsupported.
.TP
.SB BadValue
Index 0 is invalid for the specified table type.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateLookupTable (3)
.BR PEXGetTableInfo (3)
.BR PEXGetPredefinedEntries (3)
.BR PEXGetDefinedIndices (3)
.BR PEXGetTableEntries (3)
.BR PEXSetTableEntries (3)
.fi