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

INQUIRE STRING DEVICE STATE (PHOP,WSOP,*,*)

Purpose

Use Inquire String Device State to inquire the current state of the specified string device on the specified workstation.

The graPHIGS API returns the current values of the specified device.

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_string_st (ws_id, string_num, store, err_ind, op_mode, echo_switch, init_string, prompt_echo, echo_area, string_data)

Input Parameters

Pint ws_id
Workstation identifier.

Pint string_num
String 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).

char **init_string
Initial string. The memory referenced by *init_string is managed by the parameter store.

Pint *prompt_echo
Prompt and echo type.

Plimit *echo_area
Echo area in DC.

Pstring_data **string_data
Data record. The memory referenced by *string_data is managed by the parameter store.

FORTRAN

PQSTS (wkid, stdnr, mldr, errind, mode, esw, lostr, istr, pet, earea, ldr, datrec)

Input Parameters

integer wkid
Workstation identifier.

integer stdnr
String device number (>=1).

integer mldr
Dimension of the 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 lostr
Number of characters returned.

character*(*) istr
Initial string.

integer pet
Prompt and echo type

real earea(4)
Echo area in DC (XMIN, XMAX, YMIN, YMAX).

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

character*80 datrec(mldr)
The data record.

FORTRAN Subset

PQSTS (wkid, stdnr, mldr, errind, mode, esw, lostr, istr, pet, earea, ldr, datrec)

Input Parameters

integer wkid
Workstation identifier.

integer stdnr
String device number (>=1).

integer mldr
Dimension of the 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 lostr
Number of characters returned.

character*80 istr
Initial string.

integer pet
Prompt and echo type

real earea(4)
Echo area in DC (XMIN, XMAX, YMIN, YMAX).

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

character*80 datrec(mldr)
The data record.

Errors

None

Related Subroutines

  • Initialize String

  • Initialize String 3

  • Inquire Default String Device Data

  • Inquire Default String Device Data 3

  • Inquire String Device State 3

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