.\" @(#)PEXGetWorkstationAttributes.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXGetWorkstationAttributes 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXGetWorkstationAttributes - Get Workstation Attribute Values
.SH SYNTAX
.HP
PEXWorkstationAttributes *PEXGetWorkstationAttributes\^(\^Display *\fIdisplay\fP\^, PEXWorkstation \fIworkstation\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 \fIworkstation\fP 1i
The resource identifier of the workstation.
.IP \fIvalue_mask\fP 1i
A mask indicating which workstation attribute values to return.
.SH RETURNS
.LP
A pointer to the workstation attribute values; a null pointer if unsuccessful.
.SH DESCRIPTION
.\" indexing
.IX PEXGetWorkstationAttributes
.IX "Workstation" "PEXGetWorkstationAttributes"
.LP
This function returns the specified workstation's attributes.
The value mask indicates which attributes are to be returned.
.BR PEXSetPWAttributeMask (3)
or
.BR PEXSetPWAttributeMaskAll (3)
should be used to setup the value mask.
.LP
PEXlib allocates memory for the returned workstation attribute values.
.BR PEXFreeWorkstationAttributes (3)
should be called to deallocate the memory.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXWorkstation;
.sp
typedef struct {
	short				drawable_update;
	int				visual_state;
	int				drawable_surface;
	int				view_update;
	PEXListOfView			defined_views;
	int				wks_update;
	PEXNPCSubVolume		req_npc_subvolume;
	PEXNPCSubVolume		cur_npc_subvolume;
	PEXViewport			req_workstation_viewport;
	PEXViewport			cur_workstation_viewport;
	int				hlhsr_update;
	PEXEnumTypeIndex		req_hlhsr_mode;
	PEXEnumTypeIndex		cur_hlhsr_mode;
	Drawable			drawable;
	PEXLookupTable		marker_bundle;
	PEXLookupTable		text_bundle;
	PEXLookupTable		line_bundle;
	PEXLookupTable		interior_bundle;
	PEXLookupTable		edge_bundle;
	PEXLookupTable		color_table;
	PEXLookupTable		depth_cue_table;
	PEXLookupTable		light_table;
	PEXLookupTable		color_approx_table;
	PEXLookupTable		pattern_table;
	PEXLookupTable		text_font_table;
	PEXNameSet			highlight_incl;
	PEXNameSet			highlight_excl;
	PEXNameSet			invisibility_incl;
	PEXNameSet			invisibility_excl;
	PEXListOfPostedStructure	posted_structures;
	unsigned long			count_priorities;
	int				buffer_update;
	int				req_buffer_mode;
	int				cur_buffer_mode;
.br
} PEXWorkstationAttributes;
.sp
typedef struct {
	unsigned short		count;		/* number of views */
	PEXTableIndex		*views;
.br
} PEXListOfView;
.sp
typedef  unsigned short	PEXTableIndex;
.sp
typedef struct {
	PEXCoord	min;
	PEXCoord	max;
.br
XNPCSubVolume;
.sp
typedef struct {
	float	x;
	float	y;
	float	z;
.br
} PEXCoord;
.sp
typedef struct {
	PEXDeviceCoord	min;
	PEXDeviceCoord	max;
	PEXSwitch		use_drawable;
	unsigned char		reserved[3];
.br
} PEXViewport;
.sp
typedef struct {
	short	x;
	short	y;
	float	z;
.br
} PEXDeviceCoord;
.sp
typedef  unsigned char	PEXSwitch;
.sp
typedef  short	PEXEnumTypeIndex;
typedef  XID	PEXLookupTable;
typedef  XID	PEXNameSet;
.sp
typedef struct {
	unsigned long		count;		/* number of posted structures*/
	PEXPostedStructure	*structures;
.br
} PEXListOfPostedStructure;
.sp
typedef struct {
	PEXStructure	sid;
	float		priority;
.br
} PEXPostedStructure;
.sp
typedef  XID	PEXStructure;
.fi
.SH ERRORS
.TP
.SB BadPEXWorkstation
The specified workstation resource identifier is invalid.
.TP
.SB BadValue
An invalid bit is set in the value mask.
.SH SEE ALSO
.LP
.nf
.BR PEXGetWorkstationDynamics (3)
.BR PEXSetPWAttributeMask (3)
.BR PEXSetPWAttributeMaskAll (3)
.fi