.\" @(#)PEXGetSearchContext.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetSearchContext 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetSearchContext - Get Search Context Attributes
.SH SYNTAX
.HP
PEXSCAttributes *PEXGetSearchContext\^(\^Display *\fIdisplay\fP\^, PEXSearchContext \fIcontext\fP\^, unsigned long \fIvalue_mask\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 to be queried.
.IP \fIvalue_mask\fP 1i
A mask indicating which attributes to return.
.SH RETURNS
.LP
A pointer to the requested attribute values; a null pointer if unsuccessful.
.SH DESCRIPTION
.\" indexing
.IX PEXGetSearchContext
.IX "Search Context" PEXGetSearchContext
.LP
This function returns the requested attribute values of the specified search
.I context
resource.  The
value mask indicates which attributes are to be returned.
The value mask is constructed by OR'ing together the following constants:
.LP
.nf
.RS
.B PEXSCCeiling
.B PEXSCDistance
.B PEXSCInvertedList
.B PEXSCModelClipFlag
.B PEXSCNormalList
.B PEXSCPosition
.B PEXSCStartPath
.RE
.fi
.LP
PEXlib allocates memory for the returned search
.I context
attribute values.
.BR PEXFreeSCAttributes (3)
should be called to deallocate the memory.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXSearchContext;
.sp
typedef struct {
	PEXCoord		position;
	float			distance;
	unsigned short		ceiling;
	Bool			model_clip_flag;
	PEXStructurePath	start_path;
	PEXListOfNameSetPair	normal;
	PEXListOfNameSetPair	inverted;
.br
} PEXSCAttributes;
.sp
typedef struct {
	float	x;
	float	y;
	float	z;
.br
} PEXCoord;
.bp
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;
.sp
typedef struct {
	unsigned short		count;		/* number of pairs */
	PEXNameSetPair	*pairs;
.br
} PEXListOfNameSetPair;
.sp
typedef struct {
	PEXNameSet	inclusion;
	PEXNameSet	exclusion;
.br
} PEXNameSetPair;
.sp
typedef  XID	PEXNameSet;
.fi
.SH ERRORS
.TP
.SB BadPEXSearchContext
The specified search
.I context
resource identifier is invalid.
.TP
.SB BadValue
An invalid bit is set in the value mask.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateSearchContext (3)
.BR PEXChangeSearchContext (3)
.BR PEXFreeSCAttributes (3)
.fi