PEXGetSearchContext(3) — Subroutines

Name

PEXGetSearchContext - Get Search Context Attributes

Synopsis

PEXSCAttributes ∗PEXGetSearchContext(Display ∗display, PEXSearchContext context, unsigned long value_mask)

Arguments

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

contextThe resource identifier of the search context to be queried.

value_maskA mask indicating which attributes to return.

Returns

A pointer to the requested attribute values; a null pointer if unsuccessful.

Description

This function returns the requested attribute values of the specified search context resource. The value mask indicates which attributes are to be returned. The value mask is constructed by or’ing together the following constants:

PEXSCPosition
PEXSCDistance
PEXSCCeiling
PEXSCModelClipFlag
PEXSCStartPath
PEXSCNormalList
PEXSCInvertedList

PEXlib allocates memory for the returned search context attribute values. PEXFreeSCAttributes should be called to deallocate the memory.

Data Structures

typedef XID             PEXSearchContext;
typedef struct {
    PEXCoord            position;
    float               distance;
    unsigned short      ceiling;
    Bool                model_clip_flag;
    PEXStructurePath    start_path;
    PEXListOfNameSetPair normal;
    PEXListOfNameSetPair inverted;
} PEXSCAttributes;
typedef struct {
    float               x;
    float               y;
    float               z;
} PEXCoord;
typedef struct {
    unsigned long       count;
    PEXElementRef       ∗elements;
} PEXStructurePath;
typedef struct {
    PEXStructure        structure;
    unsigned long       offset;
} PEXElementRef;
typedef XID             PEXStructure;
typedef struct {
    unsigned short      count;
    PEXNameSetPair      ∗pairs;
} PEXListOfNameSetPair;
typedef struct {
    PEXNameSet          inclusion;
    PEXNameSet          exclusion;
} PEXNameSetPair;
typedef XID             PEXNameSet;

Errors

BadPEXSearchContext
The specified search context resource identifier is invalid.

BadValueAn invalid bit is set in the value mask.

Museum