PEXGetPickMeasure(3) — Subroutines

Name

PEXGetPickMeasure - Get Pick Measure Attributes

Synopsis

PEXPMAttributes ∗PEXGetPickMeasure(Display ∗display, PEXPickMeasure pick_measure, unsigned long value_mask)

Arguments

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

pick_measure
The resource identifier of the pick measure.

value_maskA mask indicating which attributes to return.

Returns

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

Description

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

PEXPMStatus
PEXPMPath

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

Data Structures

typedef XID             PEXPickMeasure;
typedef struct {
    unsigned short      status;
    PEXPickPath         pick_path;
} PEXPMAttributes;
typedef struct {
    unsigned long       count;
    PEXPickElementRef   ∗elements;
} PEXPickPath;
typedef struct {
    PEXStructure        sid;
    unsigned long       offset;
    unsigned long       pick_id;
} PEXPickElementRef;
typedef XID             PEXStructure;

Errors

BadPEXPickMeasure
The specified pick measure resource identifier is invalid.

BadValueAn invalid bit is set in the value mask.

Museum