PEXGetStructuresInNetwork - Get Structures in Network (5.0)

Synopsis

 
   PEXStructure *PEXGetStructuresInNetwork(
         Display *display,
         PEXStructure structure,
         int which,
         unsigned long *count_return
   )

Arguments

display: A pointer to a display structure returned by a successful XOpenDisplay call.
structure: The resource identifier of the root structure in the structure network.
which: A value indicating which structure resource identifiers to return (PEXAll or PEXOrphans).
count_return: Returns the number of structure resource identifiers returned.

Returns

An array of structure resource identifiers; a null pointer if unsuccessful.

Description

Invoke PEXGetStructuresInNetwork to get a list of unique structure resource identifiers that are referenced in the structure network rooted at the specified root structure.

PEXlib defines the following values for which:

PEXAll -: indicates that identifiers of all structure resources referenced in the structure network are returned.
PEXOrphans -: indicates that identifiers returned are those not referenced by any structures outside of those in the specified structure network.

The specified structure identifier is always returned in the list, unless it is an invalid structure identifier, in which case the returned list is empty.

PEXlib allocates memory for the return value. Invoke XFree to deallocate the memory.

Errors