.\" @(#)PEXGetStructuresInNetwork.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetStructuresInNetwork 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetStructuresInNetwork - Get Structures in Network
.SH SYNTAX
.HP
PEXStructure *PEXGetStructuresInNetwork\^(\^Display *\fIdisplay\fP\^, PEXStructure \fIstructure\fP\^, int \fIwhich\fP\^, unsigned long *\fIcount_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 root structure in the
structure network.
.IP \fIwhich\fP 1i
A value indicating which structure resource identifiers to return (
.B PEXAll
or
.B PEXOrphans
).
.IP \fIcount_return\fP 1i
Returns the number of structure resource identifiers returned.
.SH RETURNS
.LP
An array of structure resource identifiers; a null pointer if unsuccessful.
.SH DESCRIPTION
.\" indexing
.IX PEXGetStructuresInNetwork
.LP
This function returns a list of unique structure
resource identifiers that are
referenced in the structure network rooted at the specified
.I structure.
.B PEXAll
indicates that identifiers of all
structure resources referenced in the structure network
are returned.
.B PEXOrphans
indicates that identifiers returned are those
not referenced by any structures outside of those in the
specified
.I structure
network.
.LP
The specified
.I structure
identifier will always be returned in the list, unless
it is an invalid structure
identifier, in which case the returned list will be empty.
.LP
PEXlib allocates memory for the return value.
.B XFree
should be called to deallocate the memory.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXStructure;
.fi
.sp
.SH ERRORS
.TP
.SB BadPEXStructure
The specified structure resource identifier is invalid.
.TP
.SB BadValue
The specified value for which parameter is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateStructure (3)
.BR PEXGetAncestors (3)
.BR PEXGetDescendants (3)
.fi