PEXSearchNetwork(3) — Subroutines

Name

PEXSearchNetwork - Search Network

Synopsis

Status PEXSearchNetwork(Display ∗display, PEXSearchContext context, PEXStructurePath ∗∗path_return)

Arguments

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

contextThe resource identifier of the search context.

path_returnReturns a pointer to a structure network path identifying the first primitive found.

Returns

Zero if unsuccessful; non-zero otherwise.

Description

This function searches a structure network according to the specified search criteria. The path to the first primitive found that satisfies the search criteria is returned. If no primitive is found that satisfies the criteria, a null pointer is returned.

After the search has been completed, the start path attribute of the specified search context will be set to the path returned, if a primitive was found.

PEXlib allocates memory for the returned structure path. PEXFreeStructurePaths should be called to deallocate the memory.

Data Structures

typedef XID             PEXSearchContext;
typedef struct {
    unsigned long       count;
    PEXElementRef       ∗elements;
} PEXStructurePath;
typedef struct {
    PEXStructure        structure;
    unsigned long       offset;
} PEXElementRef;
typedef XID             PEXStructure;

Errors

BadPEXPathThe specified path is invalid.

BadPEXSearchContext
The specified search context resource identifier is invalid.

Museum