[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface: ISO PHIGS Subroutine Reference

INQUIRE LOCATOR DEVICE STATE 3 (PHOP,WSOP,*,*)

Purpose

Use Inquire Locator Device State 3 to inquire the current state of the specified locator device on the specified workstation. Returned values of type SET or REALIZED may be specified.

If the information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. If the information is unavailable, then the values returned in the output parameters are unpredictable and the graPHIGS API sets the error indicator to one of the following errors:

3
Function Requires State (PHOP,WSOP,*,*)
54
Specified Workstation Is Not Open
61
Specified Workstation Is Not Of Category Input Or Outin
250
Specified Device Not Available On Workstation

Language Bindings

C

pinq_loc_st3 (ws_id, loc_num, type, store, err_ind, op_mode, echo_switch, init_view_ind, init_loc_pos, prompt_echo, echo_vol, loc_data)

Input Parameters

Pint ws_id
Workstation identifier.

Pint loc_num
Locator device number (>=1).

Pinq_type type
Type of returned values (0=PINQ_SET, 1=PINQ_REALIZED).

Pstore store
Handle to the store object. The graPHIGS API uses an object of type Store to facilitate the use of subroutines which return complex data. See Create Store ( CREATE STORE (PHOP,*,*,*)) subroutine for details on how the graPHIGS API uses this parameter on inquiries.

Output Parameters

Pint *err_ind
Error indicator.

Pop_mode *op_mode
Operating mode (0=POP_REQ, 1=POP_SAMPLE, 2=POP_EVENT).

Pecho_switch *echo_switch
Echo switch (0=PSWITCH_NO_ECHO, 1=PSWITCH_ECHO).

Pint *init_view_ind
Initial view index.

Ppoint3 *init_loc_pos
Initial locator position in WC.

Pint *prompt_echo
Prompt and echo type.

Plimit3 *echo_vol
Echo volume in DC.

Ploc_data3 **loc_data
Data record. The memory referenced by *loc_data is managed by the parameter store.

FORTRAN

PQLCS3 (wkid, lcdnr, type, mldr, errind, mode, esw, iviewi, ipx, ipy, ipz, pet, evol, ldr, datrec)

Input Parameters

integer wkid
Workstation identifier.

integer lcdnr
Locator device number (>=1).

integer type
Type of returned values (0=PSET, 1=PREALI).

integer mldr
Dimension of data record array (>=0).

Output Parameters

integer errind
Error indicator.

integer mode
Operating mode (0=PREQU, 1=PSAMPL, 2=PEVENT).

integer esw
Echo switch (0=PNECHO, 1=PECHO).

integer iviewi
Initial view index.

real ipx
x coordinate of the initial locator position in WC.

real ipy
y coordinate of the initial locator position in WC.

real ipz
z coordinate of the initial locator position in WC.

integer pet
Prompt and echo type.

real evol(6)
Echo volume in DC (XMIN, XMAX, YMIN, YMAX, ZMIN, ZMAX).

integer ldr
Number of array elements used in the data record.

integer character*80 datrec(mldr)
Data record.

Errors

None

Related Subroutines

  • Initialize Locator

  • Initialize Locator 3

  • Inquire Default Locator Device Data

  • Inquire Default Locator Device Data 3

  • Inquire Locator Device State

    • [ Previous | Next | Contents | Glossary | Home | Search ]