.\" @(#)PEXGetTableEntries.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetTableEntries 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetTableEntries - Get Lookup Table Entries
.SH SYNTAX
.HP
Status PEXGetTableEntries\^(\^Display *\fIdisplay\fP\^, PEXLookupTable \fItable\fP\^, unsigned int \fIstart\fP\^, unsigned int \fIcount\fP\^, int \fIvalue_type\fP\^, int *\fItable_type_return\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 \fItable\fP 1i
The resource identifier of the lookup table from which
the table entries are to be obtained.
.IP \fIstart\fP 1i
The index of the first lookup table entry to be returned.
.IP \fIcount\fP 1i
The number of entries requested.
.IP \fIvalue_type\fP 1i
The type of values to return (
.B PEXSetValue
or
.B PEXRealizedValue
).
.IP \fItable_type_return\fP 1i
Returns the type of table.
.IP \fIentries_return\fP 1i
Returns an array of table entries.
.SH RETURNS
.LP
Zero if unsuccessful, non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXGetTableEntries
.IX "Lookup Table" PEXGetTableEntries
.LP
This function returns the values associated with a range of contiguous table
indices, starting at the specified entry index.
If a table entry in the requested range is
not defined, the default entry for a table of this type is returned.
.LP
The type of entries in the returned list depend on the returned table 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 the memory for the returned entries.
.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
The sum of start and count is too large, or 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 PEXGetTableEntry (3)
.BR PEXSetTableEntries (3)
.fi