NAME

SET LOCATOR MODE − set locator device operating mode and echoing state

SYNOPSIS

C Syntax

void
pset_loc_mode ( ws, dev, mode, echo )
Pintws;workstation identifier
Pintdev;locator device number
Pop_modemode;operating mode
Pecho_switchecho;echo switch

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

SET LOCATOR MODE sets the operating mode and echo switch for a specified locator device on a specified workstation. 

C Input Parameters

wsThe workstation identifier of the workstation associated with the device. 

devThe device number of the locator device to be set.  See the Available Devices section in INITIALIZE LOCATOR 3 for a description of the available devices. 

modeSpecifies the operating mode for the specified locator device.  Pop_mode is an enumeration defined in phigs.h as follows:

typedef enum {
POP_REQ,
POP_SAMPLE,
POP_EVENT
} Pop_mode;

echoThe echo switch value for the specified locator device.  Pecho_switch is an enumeration defined in phigs.h as follows:

typedef enum {
PSWITCH_NO_ECHO,
PSWITCH_ECHO
} Pecho_switch;

Execution

SET LOCATOR MODE sets the operating mode and echo flag of the specified device.  The default operating mode is POP_REQ.  The default echo switch is PSWITCH_ECHO. 

The operating mode controls how the input from the device is obtained:

•If the operating mode is REQUEST, REQUEST LOCATOR {3} may be used to prompt for and receive input from a locator input device.  REQUEST LOCATOR {3} will not return until the operator enters input to the device. 

•If the operating mode is SAMPLE, SAMPLE LOCATOR {3} may be used to return the current input value of the device without waiting for operator input. 

•If the operating mode is EVENT, the input values generated by the operator are added to the PHIGS input event queue.  The functions AWAIT EVENT and GET LOCATOR {3} may then be used to retrieve these events from the input queue. 

The echo switch may be used by some devices to control whether or not values selected by the operator are echoed to the device. 

ERRORS

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open

061Ignoring function, specified workstation is neither of category INPUT nor of category OUTIN

250Ignoring function, the specified device is not available on the specified workstation

SEE ALSO

REQUEST LOCATOR 3 (3P)
SAMPLE LOCATOR 3 (3P)
GET LOCATOR 3 (3P)
INQUIRE LOCATOR DEVICE STATE 3 (3P)
INITIALIZE LOCATOR 3 (3P)

September 02, 1992