PEXGetStructuresInNetwork(3) — Subroutines

Name

PEXGetStructuresInNetwork - Get Structures in Network

Synopsis

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

Arguments

displayA pointer to a display structure returned by a successful XOpenDisplay call.

structureThe resource identifier of the root structure in the structure network.

whichA value indicating which structure resource identifiers to return (PEXAll or PEXOrphans).

count_returnReturns the number of structure resource identifiers returned.

Returns

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

Description

This function returns a list of unique structure resource identifiers that are referenced in the structure network rooted at the specified structure. 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 will always be returned in the list, unless it is an invalid structure identifier, in which case the returned list will empty.

PEXlib allocates memory for the return value. XFree should be called to deallocate the memory.

Data Structures

typedef XID PEXStructure;

Errors

BadPEXStructure
The specified structure resource identifier is invalid.

BadValueThe specified value for which parameter is invalid

Museum