.\" @(#)PEXGetPickMeasure.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetPickMeasure 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetPickMeasure - Get Pick Measure Attributes
.SH SYNTAX
.HP
PEXPMAttributes *PEXGetPickMeasure\^(\^Display *\fIdisplay\fP\^, PEXPickMeasure
\fIpick_measure\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 \fIpick_measure\fP 1i
The resource identifier of the pick measure.
.IP \fIvalue_mask\fP 1i
A mask indicating which attributes to return.
.SH RETURNS
.LP
A pointer to the pick measure attribute values; a null pointer if unsuccessful.
.SH DESCRIPTION
.\" indexing
.IX PEXGetPickMeasure
.IX "Pick Measure" PEXGetPickMeasure
.LP
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:
.LP
.RS
.nf
.B PEXPMStatus
.B PEXPMPath
.RE
.fi
.LP
PEXlib allocates memory for the return value.
.BR PEXFreePMAttributes (3)
should be called to deallocate the memory.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXPickMeasure;
.sp
typedef struct {
	unsigned short		status;
	PEXPickPath		pick_path;
.br
} PEXPMAttributes;
.sp
typedef struct {
	unsigned long		count;		/* number of elements */
	PEXPickElementRef	*elements;
.br
} PEXPickPath;
.sp
typedef struct {
	PEXStructure		sid;
	unsigned long		offset;
	unsigned long		pick_id;
.br
} PEXPickElementRef;
.sp
typedef  XID	PEXStructure;
.fi
.SH ERRORS
.TP
.SB BadPEXPickMeasure
The specified
.I pick_measure
resource identifier is invalid.
.TP
.SB BadValue
An invalid bit is set in the value mask.
.SH SEE ALSO
.LP
.nf
.BR PEXCreatePickMeasure (3)
.fi