.\" @(#)PEXSearchNetwork.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXSearchNetwork 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXSearchNetwork - Search Network
.SH SYNTAX
.HP
Status PEXSearchNetwork\^(\^Display *\fIdisplay\fP\^, PEXSearchContext \fIcontext\fP\^, PEXStructurePath **\fIpath_return\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIcontext\fP 1i
The resource identifier of the search context.
.IP \fIpath_return\fP 1i
Returns a pointer to a structure network path identifying the first primitive
found.
.SH RETURNS
.LP
Zero if unsuccessful; non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXSearchNetwork
.LP
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.
.LP
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.
.LP
PEXlib allocates memory for the returned structure path.
.BR PEXFreeStructurePaths (3)
should be called to deallocate the memory.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXSearchContext;
.sp
typedef struct {
	unsigned long		count;		/* number of elements */
	PEXElementRef		*elements;
.br
} PEXStructurePath;
.sp
typedef struct {
	PEXStructure		structure;
	unsigned long		offset;
.br
} PEXElementRef;
.sp
typedef  XID	PEXStructure;
.Le
.SH ERRORS
.TP
.SB BadPEXPath
The specified path is invalid.
.TP
.SB BadPEXSearchContext
The specified search context resource identifier is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateSearchContext (3)
.BR PEXChangeSearchContext (3)
.BR PEXFreeStructurePaths (3)
.fi