.\" @(#)PEXGetElementInfo.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetElementInfo 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetElementInfo - Get Element Information
.SH SYNTAX
.HP
Status PEXGetElementInfo\^(\^Display *\fIdisplay\fP\^, PEXStructure \fIstructure\fP\^, int \fIwhence1\fP\^, long \fIoffset1\fP\^, int \fIwhence2\fP\^, long \fIoffset2\fP\^, int \fIfloat_format\fP\^, unsigned long *\fIcount_return\fP\^, PEXElementInfo **\fIinfo_return\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIstructure\fP 1i
The resource identifier of the structure.
.IP \fIwhence1\fP 1i
A value specifying, with \fIoffset1\fP, the first limit of the range of
queried elements (
.B PEXBeginning,
.B PEXCurrent,
.B PEXEnd
).
.IP \fIoffset1\fP 1i
The offset from \fIwhence1\fP denoting the first limit of the range of
queried elements.
.IP \fIwhence2\fP 1i
A value specifying, with \fIoffset2\fP, the second limit of the range of
elements to be queried (
.B PEXBeginning,
.B PEXCurrent,
.B PEXEnd
).
.IP \fIoffset2\fP 1i
The offset from \fIwhence2\fP denoting the second limit of the range of
elements to be queried.
.IP \fIfloat_format\fP 1i
The floating point format to use when computing element sizes (
.B PEXIEEE_754_32,
.B PEXDEC_F_Floating,
.B PEXIEEE_754_64,
.B PEXDEC_D_Floating
).
.IP \fIcount_return\fP 1i
Returns the number element info records returned.
.IP \fIinfo_return\fP 1i
Returns an array of element info records describing the elements in the
specified range.
.SH RETURNS
.LP
Zero if unsuccessful, non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXGetElementInfo
.LP
This function returns information about a range of elements from the
specified structure.
.LP
If a computed offset is less than zero it is set to
zero before obtaining the element information.  If a
computed offset is greater than the number of elements in the
structure, it is set to the offset of the last structure element
in the structure.  The element pointer attribute of structure
is not affected by this command.
.LP
Information returned about the list of inquired elements
includes the type of each element and its size.
The size of each element is based upon the specified floating point format.
No information is returned for inquires on element offset zero.
The element pointer is not affected by this function.
.LP
PEXlib allocates memory for the return value.
.B XFree
should be called to deallocate the memory.
.bp
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXStructure;
.sp
typedef struct {
	unsigned short		type;
	unsigned short		length;
.br
} PEXElementInfo;
.fi
.SH ERRORS
.TP
.SB BadPEXFloatingPointFormat
The specified floating point format is invalid or unsupported.
.TP
.SB BadPEXStructure
The specified
.I structure
resource identifier is invalid.
.TP
.SB BadValue
The specified value for
.I whence
parameter is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateStructure (3)
.fi