PEXGetPickDevice - Get Pick Device Attributes

Synopsis

 
  PEXPDAttributes *PEXGetPickDevice(
        Display *display,
        PEXWorkstation workstation,
        int pick_device_type,
        unsigned long value_mask
   )
 

Arguments

display

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

workstation

The resource identifier of the workstation.

pick_device_type

The pick device type (PEXPickDeviceDCHitBox or PEXPickDeviceNPCHitVolume).

value_mask

A mask indicating which attributes to return.

Returns

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

Description

Invoke PEXGetPickDevice to get the attribute values of a pick descriptor for the PHIGS workstation resource specified.

This function returns a descriptor which is the currently-defined descriptor for the pick device of the pick device type specified. Inquire the supported pick device types by invoking the PEXGetEnumTypeInfo function.

Use the value mask to indicate which attributes are to be returned. The value mask is constructed by or'ing together the following constants:

• PDPickStatus
• PDPickPath
• PDPickPathOrder
• PDPickIncl
• PDPickExcl
• PDPickDataRec
• PDPromptEchoType
• PDEchoVolume
• PDEchoSwitch

PEXlib allocates memory for the return value. Invoke PEXFreePDAttributes to deallocate the memory.

Errors

BadPEXWorkstation

The specified workstation resource identifier is invalid.

BadValue

The specified pick device type is invalid, or an invalid bit set in the value mask.

See Also

• PEXChangePickDevice
• PEXGetEnumTypeInfo

For a list of all PHIGS Workstation Picking functions and related topics, see PHIGS Workstation Picking.