.\" @(#)PEXGetStructureInfo.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetStructureInfo 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetStructureInfo - Get Structure Information
.SH SYNTAX
.HP
Status PEXGetStructureInfo\^(\^Display *\fIdisplay\fP\^, PEXStructure \fIstructure\fP\^, int \fIfloat_format\fP\^, unsigned long \fIvalue_mask\fP\^, PEXStructureInfo *\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 \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 \fIvalue_mask\fP 1i
A mask indicating which values to return.
.IP \fIinfo_return\fP 1i
Returns information about the
.I structure
resource.
.SH RETURNS
.LP
Zero if unsuccessful, non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXGetStructureInfo
.LP
This function returns information about the specified
.I structure
resource.
The value mask is constructed by OR'ing together the following constants:
.LP
.RS
.nf
.B PEXEditMode
.B PEXElementPtr
.B PEXHasRefs
.B PEXLengthStructure
.B PEXNumElements
.RE
.fi
.LP
The length of the structure is given in the number of 4-byte units, and is
based upon the specified floating point format.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXStructure;
.sp
typedef struct {
	unsigned long	element_count;
	unsigned long	size;
	Bool		has_refs;
	unsigned short	edit_mode;
	unsigned long	element_pointer;
.br
} PEXStructureInfo;
.fi
.SH ERRORS
.TP
.SB BadPEXFloatingPointFormat
The specified floating point format is invalid or unsupported.
.TP
.SB BadPEXStructure
The specified structure resource identifier is invalid.
.TP
.SB BadValue
An invalid bit is set in the value mask.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateStructure (3)
.fi