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

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

Purpose

Use Inquire Choice Device State 3 to inquire the current state of the specified choice device on the specified workstation.

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_choice_st3 (ws_id, choice_num, store, err_ind, op_mode, echo_switch, init_status, init_choice, prompt_echo, echo_vol, choice_data)

Input Parameters

Pint ws_id
Workstation identifier.

Pint choice_num
Choice device number (>=1).

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).

Pin_status *init_status
Initial choice status (1=PIN_STATUS_OK, 2=PIN_STATUS_NO_IN).

Pint *init_choice
Initial choice number.

Pint *prompt_echo
Prompt and echo type.

Plimit3 *echo_vol
Prompt and echo volume.

Pchoice_data3 **choice_data
Data record. The memory referenced by *choice_data is managed by the parameter store.

FORTRAN

PQCHS3 (wkid, chdnr, mldr, errind, mode, esw, istat, ichnr, pet, evol, ldr, datrec)

Input Parameters

integer wkid
Workstation identifier.

integer chdnr
Choice device number (>=1).

integer mldr
Dimension of data record array.

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 istat
Initial choice status (1=POK, 2=PNCHOI).

integer ichnr
Initial choice number.

integer pet
Prompt and echo type.

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

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

character*80 datrec(mldr)
Data record.

Errors

None

Related Subroutines

  • Initialize Choice

  • Initialize Choice 3

  • Inquire Choice Device State 3


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