INQUIRE LOCATOR DEVICE STATE(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE LOCATOR DEVICE STATE − inquire state of a locator device

SYNOPSIS

C Syntax

void
pinq_loc_st ( ws, dev, type, store, err, op_mode, echo_switch, init_view_ind, init_loc_pos, prompt_echo,
echo_area, loc_data)
Pintws;workstation identifier
Pintdev;locator device number
Pinq_typetype;type of returned value
Pstorestore;pointer to buffer
Pint∗err;OUT error indicator
Pop_mode∗op_mode;OUT operating mode
Pecho_switch∗echo_switch;OUT echo switch
Pint∗init_view_ind;OUT initial view index
Ppoint∗init_loc_pos;OUT initial locator position
Pint∗prompt_echo;OUT prompt/echo type
Plimit∗echo_area;OUT echo area
Ploc_data∗∗loc_data;OUT data record

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE LOCATOR DEVICE STATE to determine the current state of the specified locator device.

C Input Parameters

Applications using the C binding must create a buffer to be used by this function as memory space for storing data associated with the device state. This buffer is passed as the store argument.

The store buffer is a data area managed by PHIGS API. While the application is responsible for creating the inital buffer through a call to CREATE STORE, the implementation manages this area such that there is sufficient memory for the specific inquiry. The locator device data record within the store buffer is accessed by the pointer pointed to by loc_data.

wsWorkstation identifier. An integer specifying the workstation with which the specified locator device is associated.

devThe device number of the locator device. See the Available Devices section of INITIALIZE LOCATOR for a description of the available devices.

typeAn enumerated value specifying whether the values to be returned are those originally specified by the application (SET), or those resulting after PHIGS mapped them to ones available on the workstation (REALIZED). A Pinq_type structure is defined as:

typedef enum {
PINQ_SET,
PINQ_REALIZED
} Pinq_type;

storeThe memory buffer PHIGS is to use for storing the information returned. This buffer must exist prior to calling this function (see CREATE STORE (3P)).

C Output Parameters

errThe error indicator. See the Execution section below for a description of its use. See the Errors section below for the possible values it may return.

op_mode
The operating mode. Pop_mode is an enumerated type with the following values:

POP_REQ
POP_SAMPLE
POP_EVENT

echo_switch
The echo state. Pecho_switch is an enumerated type with the following values:

PSWITCH_ECHO
PSWITCH_NO_ECHO

init_view_ind
Initial view index.

init_loc_pos
Intitial locator position.

prompt_echo
The prompt/echo type desired. See the Available Devices Section of INITIALIZE LOCATOR for a description of the available types.

echo_area
A pointer to a variable of type Plimit that contains the echo area of the device. Plimit is defined in phigs.h as follows:

typedef struct {
Pfloatx_min;/∗ x min ∗/
Pfloatx_max;/∗ x max ∗/
Pfloaty_min;/∗ y min ∗/
Pfloaty_max;/∗ y max ∗/
} Plimit;

loc_data
Pointer to a pointer to the locator device record within the store data buffer.

Execution

INQUIRE LOCATOR DEVICE STATE returns the current state of the specified locator device, which is stored in the workstation state list of the workstation associated with the device. The current state includes the operating mode, echo switch, initial locator value, prompt/echo type, echo area, and data record. See SET LOCATOR MODE for a description of the operating mode and the echo switch and how to set these values. See INITIALIZE LOCATOR for a description of the initial locator value, prompt/echo type, echo area, and data record contents and how to set these values.

In the event of an error, the error indicator indicates the error number of the error detected, and no other output data is returned. If no error is detected, the error indicator is set to zero, and the inquired information will be available in the output parameters. Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

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

Museum