[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface: Technical Reference

Appendix A. State Lists

You may wish to know the specific data types and representations supported by the graPHIGS APIscreen

This appendix shows you the description of the data fields and their data types for State Lists and description tables which are used by the API, and may be queried by the application program. They are:

   Operating States List (OSL)
   graPHIGS API Descriptor Table (PDT)
   graPHIGS API State List (PSL)
   Structure Store State List (SSL)
   Workstation State List (WSL)
   graPHIGS API Error State List (ESL)
   Utility Function State List (USL)

Data Type Field

In the tables and lists presented in this appendix, the following correspondence applies to the abbreviated data types:

Data Type Definition
I Integer A whole number
R Real A floating-point number
S String A character string
E Enumeration A data type comprised of a set of values. The set is defined by enumerating the identifiers denoting the values.
n Quantity This specifies an undesignated quantity of data.
Note: The notation of n (number) x t (data type) indicates a collection of data of that type. This can be indicated in one of two ways:
  1. by using notation such as 3xR (three real numbers), which could specify something like the x, y, and z coordinates of a three-dimensional point or RGB values
  2. by using a variable number such as nxI, which specifies a collection of n integers.

Operating States

The graPHIGS API defines four state variables. These variables determine the current operating status of each component in the system. Before the API is invoked, all states are CLOSED.

The right-hand column lists the inquiry function that you can use when you want your application to know the operating states of the system.

Data Type Field

In the tables and lists presented in this appendix, the following correspondence applies to the abbreviated data types:

Data Type Definition
I Integer A whole number
R Real A floating-point number
S String A character string
E Enumeration A data type comprised of a set of values. The set is defined by enumerating the identifiers denoting the values.
n Quantity This specifies an undesignated quantity of data.
Note: The notation of n (number) x t (data type) indicates a collection of data of that type. This can be indicated in one of two ways:
  1. by using notation such as 3xR (three real numbers), which could specify something like the x, y, and z coordinates of a three-dimensional point or RGB values
  2. by using a variable number such as nxI, which specifies a collection of n integers.

graPHIGS API Descriptor Table (PDT):

Description of Field Data Type Inquiry
Archive state value 
(AROP, ARCL)
 E GPQASV[state]
System state value 
(CLOSED, OPEN)
 E GPQSYV[state]
Workstation state value 
(CLOSED, OPEN, SELECTED)
 E GPQWSV[state]
Structure state value 
(STRUCTURE STORE SELECTED BUT NO STRUCTURE IS OPEN [STCL],
 STRUCTURE STORE SELECTED AND A STRUCTURE IS OPEN [STOP],
 NO STRUCTURE STORE ATTACHED/CREATED [SSCL],
 STRUCTURE STORE ATTACHED/CREATED BUT NOT SELECTED [SSOP],
 [NROP])
 E GPQSTV[state]

The graPHIGS API Descriptor Table (PDT)

This list indicates the values which describe the capabilities of the graPHIGS APIscreen The right-hand column lists the inquiry function that you can use when you want your application to know the capabilities of the graPHIGS APIscreen

Data Type Field

In the tables and lists presented in this appendix, the following correspondence applies to the abbreviated data types:

Data Type Definition
I Integer A whole number
R Real A floating-point number
S String A character string
E Enumeration A data type comprised of a set of values. The set is defined by enumerating the identifiers denoting the values.
n Quantity This specifies an undesignated quantity of data.
Note: The notation of n (number) x t (data type) indicates a collection of data of that type. This can be indicated in one of two ways:
  1. by using notation such as 3xR (three real numbers), which could specify something like the x, y, and z coordinates of a three-dimensional point or RGB values
  2. by using a variable number such as nxI, which specifies a collection of n integers.
Description of Field Data Type Inquiry
Number of available connection methods I GPQCMM[totnum]
List of available connection methods nxI GPQCMM[conn]
Number of available application image formats I GPQAI[totnum]
List of available application image formats nxI GPQAI[format]

The graPHIGS API State List (PSL)

This list indicates the values maintained by the graPHIGS API which describe its current state. As your application runs, the values can change. The right-hand column lists the inquiry function that you can use when you want your application to acquire the values.

Data Type Field

The following correspondence applies to the abbreviated data types:

Data Type Definition
I Integer A whole number
R Real A floating-point number
S String A character string
E Enumeration A data type comprised of a set of values. The set is defined by enumerating the identifiers denoting the values.
n Quantity This specifies an undesignated quantity of data.
Note: The notation of n (number) x t (data type) indicates a collection of data of that type. This can be indicated in one of two ways:
  1. by using notation such as 3xR (three real numbers), which could specify something like the x, y, and z coordinates of a three-dimensional point or RGB values
  2. by using a variable number such as nxI, which specifies a collection of n integers.
Description of Field Data Type Inquiry
Shell product level I GPQSPL[level]
Shell identifier on a nucleus I GPQSH[shid]
Application environment descriptor 4xS GPQSH[env]
Shell deferral mode 
(FLUSH, DEFERRED, DEFERRED_PLUS_MSGS)
 E GPQSHD[deferral]
Convexity checking mode E  
Update notification mode 
(NO, YES)
 E GPQSHD[update]
Current selected structure store I GPQSSS[ssid]
Nucleus resource identifier for a resource I GPQNCR[rid]
Number of resources attached to the shell I GPQATR[totnum]
List of resources attached to the shell nxI GPQATR[id]
Number of nuclei connected to the shell I GPQCNC[totnum]
List of nucleus identifiers connected to the shell nxI GPQCNC[ncid]
Current event report n GPQCEV[major, class, minor]
Current edit mode 
(INSERT_MODE, REPLACE_MODE)
 E GPQEDM[mode]
More simultaneous events input flag 
(NOMORE, MORE)
 E GPQSEV[simevnt]
Current character set identifier I GPQCS[csid]
Current direct color model 
(RGB, HSV, CMY, CIELUV)
 E GPQDCM[model]
Number of open workstations on a nucleus I GPQOPW[totnum]
List of open workstations on a nucleus nxI GPQOPW[lwsid]
Conflict Resolution State 
(ABANDON, MAINTAIN, UPDATE)
 E GPQCNR[state]

Structure Store State List (SSL)

This list indicates the values maintained by the graPHIGS API which describe the current operating state of a structure store resource. Content of the structure store state list may change during application processing.

The right-hand column lists the inquiry function that you can use when you want your application to acquire the current values.

Data Type Field

The following correspondence applies to the abbreviated data types:

Data Type Definition
I Integer A whole number
R Real A floating-point number
S String A character string
E Enumeration A data type comprised of a set of values. The set is defined by enumerating the identifiers denoting the values.
n Quantity This specifies an undesignated quantity of data.
Note: The notation of n (number) x t (data type) indicates a collection of data of that type. This can be indicated in one of two ways:
  1. by using notation such as 3xR (three real numbers), which could specify something like the x, y, and z coordinates of a three-dimensional point or RGB values
  2. by using a variable number such as nxI, which specifies a collection of n integers.
Description of Field Data Type Inquiry
Current open structure identifier I GPQOPS[strid]
Current element pointer I GPQEP[value]
Structure existence 
(NON_EXISTENT, EXISTENT)
 E GPQSTE[flag]
Number of existing structures I GPQSTI[totnum]
List of existing structures nxI GPQSTI[lstrid]
Number of existing execute structures I GPQEXS[totnum]
List of existing execute structures nxI GPQEXS[lstrid]
List of element headers nx S GPQEHD[header]
List of element data nxS GPQED[data]
Number of workstations to which the structure is associated I GPQWSA[totnum]
List of workstations to which the structure is associated nxI GPQWSA[lwsid]

Workstation State List (WSL)

This list describes the current operating state of a given workstation. One WSL exists for each open workstation. Content of the Workstation State List may change during application processing.

The right-hand column lists the inquiry subroutine call that you can use when you want your application to acquire the current values.

Data Type Field

The following correspondence applies to the abbreviated data types:

Data Type Definition
I Integer A whole number
R Real A floating-point number
S String A character string
E Enumeration A data type comprised of a set of values. The set is defined by enumerating the identifiers denoting the values.
n Quantity This specifies an undesignated quantity of data.
Note: The notation of n (number) x t (data type) indicates a collection of data of that type. This can be indicated in one of two ways:
  1. by using notation such as 3xR (three real numbers), which could specify something like the x, y, and z coordinates of a three-dimensional point or RGB values
  2. by using a variable number such as nxI, which specifies a collection of n integers.
Description of Field Data Type Inquiry
Connection identifier S GPQRCT[olen,connid]
Workstation type (actual) S GPQRCT[wstype]
Requested workstation windows 6xR GPQWSX[rwindow]
Current workstation windows 6xR GPQWSX[cwindow]
Requested workstation viewports 6xR GPQWSX[rviewpt]
Current workstation viewports 6xR GPQWSX[cviewpt]
Table of Requested Viewing Operation Information:  
   Total number of requested viewing table entries in output priority order I GPQRVO[nview]
   Total number of requested viewing table entries in input priority order I GPQRVE[nview]
For Each View Entry:  
   Viewing transformation matrix 4x4xR GPQRVR[data--group 18, 19]
   View mapping matrix 4x4xR GPQRVR[data--group 22, 23]
   Window viewing coordinates 4xR GPQRVR[data--group 16, 17]
   Viewport (normalized projection coordinates) 6xR GPQRVR[data--group 14, 15]
   Projection (reference point viewing coordinates) 3xR GPQRVR[data--group 17]
   View plane distance R GPQRVR[data--group 17]
   Near distance R GPQRVR[data--group 17]
   Far distance R GPQRVR[data--group 17]
   Projection type 
   (PARALLEL, PERSPECTIVE)
 E GPQRVR[data--group 17]
   Window clipping indicator 
   (CLIP, NOCLIP)
 E GPQRVR[data--group 1]
   Near clipping indicator 
   (CLIP, NOCLIP)
 E GPQRVR[data--group 2]
   Far clipping indicator 
   (CLIP, NOCLIP)
 E GPQRVR[data--group 3]
   Shielding indicator 
   (OFF, ON)
 E GPQRVR[data--group 4]
   Shielding color type 
   (INDEXED, DIRECT)
 I GPQRVR[data--group 5]
   Shielding color I or 3xR GPQRVR[data--group 5]
   View border indicator 
   (OFF, ON)
 E GPQRVR[data--group 6]
   View border color type 
   (INDEXED, DIRECT)
 I GPQRVR[data--group 7]
   View border color I or 3xR GPQRVR[data--group 7]
   View active/inactive indicator for input 
   (OFF, ON)
 E GPQRVR[data--group 20]
   View active/inactive indicator for output 
   (OFF, ON)
 E GPQRVR[data--group 21]
   Temporary view indicator 
   (OFF, ON)
 E GPQRVR[data--group 9]
   HLHSR (hidden line hidden surface removal mode)     
   (OFF, ON_THE_FLY)
 E GPQRVR[data--group 10]
   Transparency mode 
   (OFF, PARTIAL_TRANSPARENT, BLEND, BLEND_ALL)
 E GPQRVR[data--group 11]
   Antialiasing mode 
   (OFF, SUBPIXEL_ON_THE_FLY, NON_SUBPIXEL_ON_THE_FLY)
 E GPQRVR[data--group 24]
   Color processing index I GPQRVR[data--group 12]
   Frame buffer write protect mask I GPQRVR[data--group 13]
Table of Current Viewing Operation Information:  
   Total number of current viewing table entries in output priority order I GPQCVO[nview]
   Total number of current viewing table entries in input priority order I GPQCVE[nview]
For Each View Entry:  
   Viewing transformation matrix 4x4xR GPQCVR[data--group 18, 19]
   View mapping matrix 4x4xR GPQCVR[data--group 22, 23]
   Window viewing coordinates 4xR GPQCVR[data--group 16, 17]
   Viewport normalized projection coordinates 6xR GPQCVR[data--group 14, 15]
   Projection reference point viewing coordinates 3xR GPQCVR[data--group 17]
   View plane distance R GPQCVR[data--group 17]
   Near distance R GPQCVR[data--group 17]
   Far distance R GPQCVR[data--group 17]
   Projection type 
   (PARALLEL, PERSPECTIVE)
 E GPQCVR[data--group 17]
   Window clipping indicator 
   (CLIP, NOCLIP)
 E GPQCVR[data--group 1]
   Near clipping indicator 
   (CLIP, NOCLIP)
 E GPQCVR[data--group 2]
   Far clipping indicator 
   (CLIP, NOCLIP)
 E GPQCVR[data--group 3]
   Shielding indicator 
   (OFF, ON)
 E GPQCVR[data--group 4]
   Shielding color type 
   (INDEXED, DIRECT)
 I GPQCVR[data--group 5]
   Shielding color I or 3xR GPQCVR[data--group 5]
   View border indicator 
   (OFF, ON)
 E GPQCVR[data--group 6]
   View border color I or 3xR GPQCVR[data--group 7]
   View border color type 
   (INDEXED, DIRECT)
 I GPQCVR[data--group 7]
   View active/inactive indicator for input 
   (OFF, ON)
 E GPQCVR[data--group 20]
   View active/inactive indicator for output 
   (OFF, ON)
 E GPQCVR[data--group 21]
   Temporary view indicator 
   (OFF, ON)
 E GPQCVR[data--group 9]
   HLHSR (hidden line hidden surface removal mode)     
   (OFF, ON_THE_FLY)
 E GPQCVR[data--group 10]
   Transparency mode 
   (OFF, PARTIAL_TRANSPARENT, BLEND, BLEND_ALL)
 E GPQCVR[data--group 11]
   Antialiasing mode 
   (OFF, SUBPIXEL_ON_THE_FLY, NON_SUBPIXEL_ON_THE_FLY)
 E GPQCVR[data--group 24]
   Color processing index I GPQCVR[data--group 12]
   Frame buffer write protect mask I GPQCVR[data--group 13]
Current deferral mode 
   (AS SOON AS POSSIBLE [ASAP],
   BEFORE NEXT INTERACTION GLOBALLY [BNIG],
   BEFORE NEXT INTERACTION LOCALLY [BNIL],
   AT SOME TIME [ASTI],
   WHEN APPLICATION REQUESTS IT [WAIT])
 E GPQDV[defer]
Current modification mode 
   (NO_IMMEDIATE_VISUAL_EFFECT, 
   UPDATE_WITHOUT_REGEN, QUICK_UPDATE)
 E GPQDV[modify]
Display surface empty flag 
   (NOT_EMPTY, IS_EMPTY)
 E GPQDV[dissurf]
Display status 
   (CORRECT, DEFERRED, SIMULATED)
 E GPQDV[dstat]
Update flag 
   (NOT_PENDING, PENDING)
 E  
Polyline Bundle Table:  
   Number of polyline bundle table entries I  
For Each Polyline Bundle Table Entry:  
   Line type 
   (SOLID_LINE, DASHED, DOTTED, DASH_DOT, LONG_DASH, 
   DOUBLE_DOT, DASH_DOUBLE_DOT) (1..n)
 E GPQXLR[data--group 1]
   Line width scale factor R GPQXLR[data--group 2]
   Polyline color
      Type
      Color		 I or 3xR GPQXLR[data--group 3]
Line Pattern Table:  
   Number of line pattern table entries I  
For Each Line Pattern Table Entry:  
   Number of sections in line pattern I GPQLTR[number]
   List of each section in the line pattern nxI GPQLTR[pattern]
Polymarker Bundle Table:  
   Number of polymarker bundle table entries I  
For Each Polymarker Bundle Table Entry:  
   Marker type 
   (DOT, PLUS_SIGN, ASTERISK, CIRCLE,
    DIAGONAL_CROSS) (1..n)
 E GPQXMR[data--group 1]
   Marker size scale factor R GPQXMR[data--group 2]
   Polymarker color
      Type
      Color		 I or 3xR GPQXMR[data--group 3]
Marker Pattern Table:  
   Number of marker pattern table entries I  
For Each Marker Pattern Table Entry:  
   Marker pattern format 
   (VECTOR)
 I GPQMTR[format]
   Length of marker pattern definition I GPQMTR[length]
   Marker pattern definition I GPQMTR[data]
Text Bundle Table:  
   Number of text bundle table entries I  
For Each Text Bundle Table Entry:  
   Text font (1..n) I GPQXTR[data--group 1]
   Text precision 
   (STRING_PREC, CHAR_PREC, STROKE_PREC)
 E GPQXTR[data--group 2]
   Character expansion factor R GPQXTR[data--group 3]
   Character spacing R GPQXTR[data--group 4]
   Text color
      Type
      Color		 I or 3xR GPQXTR[data--group 5]
Interior Bundle Table:  
   Number of interior bundle table entries I  
For Each Interior Bundle Table Entry:  
   Interior style 
   (HOLLOW, SOLID, PATTERN, HATCH,
    EMPTY) (1..n)
 E GPQXIR[data--group 1]
   Interior style index (1..n) I GPQXIR[data--group 2]
   Interior color
      Type
      Color		 I or 3xR GPQXIR[data--group 3]
Edge Bundle Table:  
   Number of edge bundle table entries I  
For Each Edge Bundle Table Entry:  
   Edge flag 
   (OFF, ON, GEOMETRY_ONLY)
 E GPQXER[data--group 1]
   Edge line type 
   (SOLID, DASHED_DOTTED_DASH_DOT,
    LONG_DASH, DOUBLE_DOT, DASH_DOUBLE_DOT) (1..n)
 E GPQXER[data--group 2]
   Edge line width scale factor R GPQXER[data--group 3]
   Edge color
      Type
      Color		 I or 3xR GPQXER[data--group 4]
Pattern Table:  
Number of pattern table entries I  
For Each Pattern Table Entry:  
   Pattern array dimension (1..n) 2xI GPQPAR[drow,dcol]
   Pattern array (0..n) nxnxI GPQPAR[array]
Hatch Table:  
   Number of hatch table entries I  
For Each Hatch Table Entry:  
   Hatch format (bit array) I GPQHR[format]
   Hatch array dimension (1...n) 2xI GPQHR[length]
   Hatch pattern array nxnxI GPQHR[data]
Character Set Table:  
   Number of character set ID/ fonts in active pool I GPQFO[nfont]
For Each Active Character Set Entry:  
   Character set identifier (1..255) I GPQFO[lcsid]
   Font identifier (1..n)
   (Note: The first character set entry is always the primary character set)		 I GPQFO[lfont]
Color Tables:  
   Number of color tables I GPQCID[totnum]
For Each Color Table:  
   Color table identifier I GPQCID[ctid]
   Color model 
   (RGB, HSV, CMY, CIELUV)
 I GPQCCH[model]
   Size of the color table I GPQCCH[length]
For Each Color Table Entry:  
   Color components 3xR GPQXCR[color]
Light Source Table:  
   Number of light source table entries I  
For Each Light Souce Table Entry:  
   Light source type 
   (AMBIENT, DIRECTIONAL,
    POSITIONAL, SPOT)
 I GPQLSR[lstype]
   Light source color
      Type
      Color		 I or 3xR GPQLSR[color]
   Light source data nxR GPQLSR[data]
Depth Cue Table:  
   Number of depth cue table entries I  
For Each Depth Cue Table Entry:  
   Depth cue mode I GPQDCR[data--group 1]
   Depth cue reference planes 2xR GPQDCR[data--group 2]
   Depth cue scale factors 2xR GPQDCR[data--group 3]
   Depth cue color
      Type
      Color		 I or 3xR GPQDCR[data--group 4]
Color Processing Mode Table:  
   Number of color processing mode table entries I  
For Each Color Processing Table Entry:  
   Rendering color model 
   (RGB, RGB_B_ONLY)
 E GPQCPR[model]
   Color quantization method     
   (WORKSTATION_DEPENDENT, BITWISE,)
 E GPQCPR[quant]
   Color quantization data   GPQCPR[data]
Cull Size Table:  
   Number of cull size table entries I  
For Each Cull Size Table Entry:  
   Cull size R GPQCSR[size]
Highlighting Information:  
   Number of classes in inclusion filter I GPQHLF[inclen]
   List of classes in inclusion filter nxI GPQHLF[incl]
   Number of classes in exclusion filter I GPQHLF[exclen]
   List of classes in exclusion filter nxI GPQHLF[excl]
Invisibility Information:  
   Number of classes in inclusion filter I GPQIVF[inclen]
   List of classes in inclusion filter nxI GPQIVF[incl]
   Number of classes in exclusion filter I GPQIVF[exclen]
   List of classes in exclusion filter nxI GPQIVF[excl]
Image Definition Table:  
   Number of defined images on the workstation I GPQIW[totnum]
   List of defined images on the workstation nxI GPQIW[limage]
For Each Defined Image Table Entry:  
   Connection type     
   (FRAME_BUFFER_COMPATIBLE, COMPONENT, INDEXED)
 E GPQICH[conn]
   Color table identifier I GPQICH[ctid]
   Number of image boards that form image I GPQICH[totnum]
   List of image boards that form image nxI GPQICH[libid]
For Each Image Board:  
   Bit depth of the image board I GPQIBC[depth]
   Size of the image board 2xI GPQIBC[h,v]
Image Display:  
   Number of image mappings of the image I GPQIMI[totnum]
   List of image mappings of the image nxI GPQIMI[limid]
   Number of image mappings for the view I GPQIMV[totnum]
   List of image mappings for the view nxI GPQIMV[limid]
   Number of image mappings on the workstation I GPQIMW[totnum]
   List of image mappings on the workstation nxI GPQIMW[limid]
For Each Image Mapping:  
   Image mapping method 
   (PIXEL_BY_PIXEL)
 E GPQIMC[method]
   View index I GPQIMC[vindex]
   Priority R GPQIMC[priority]
   Image definition index I GPQIMC[iindex]
   Image rectangle origin I GPQIMC[origin]
   Image rectangle size 2xI GPQIMC[size]
   Lower left corner of the image mapping 3xR GPQIMC[p]
   Lower right corner of the image mapping 3xR GPQIMC[q]
   Upper left corner of the image mapping 3xR GPQIMC[r]
Break Action:  
   Trigger type I GPQBKS[trigger]
   Trigger qualifier I GPQBKS[trigger]
   Number of locator devices I N/A
   Number of stroke devices I N/A
   Number of valuator devices I N/A
   Number of choice devices I N/A
   Number of pick devices I N/A
   Number of string devices I N/A
Table of Input Devices: Entries in this group do not exist for workstations of category output.
For Every Logical Input Device of Class Locator:  
   Operating mode 
   (REQUEST, PRELE, EVENT)
 E GPQLC[mode]
   Echo switch 
   (NOECHO, ECHO)
 E GPQLC[echosw]
   Prompt and echo type I GPQLC[echo]
   Current echo area (DC) 6xR GPQLC[area]
   Length of locator data record I GPQLC[datalen]
   Current locator data record   GPQLC[data]
   Current input character set identifier E GPQICS[csid]
   Initial view index I GPQLC[view]
   Initial locator position (WC) 3xR GPQLC[pos]
   Current trigger list(s) (one per trigger list identifier) n (3xI) GPQITS[ltrigs]
For Every Logical Input Device of Class Stroke:  
   Operating mode 
   (REQUEST, PRELE, EVENT)
 E GPQSK[mode]
   Echo switch 
   (NOECHO, ECHO)
 E GPQSK[echosw]
   Prompt and echo type I GPQSK[echo]
   Current echo area (DC) 6xR GPQSK[area]
   Length of stroke data record I GPQSK[datalen]
   Current stroke data record   GPQSK[data]
   Current input character set identifier I GPQICS[csid]
   Initial view index I GPQSK[view]
   Number of points in initial stroke I GPQSK[npoint]
   List of initial points (WC) nxR GPQSK[point array]
   Input buffer size I GPQSK[buffer]
   Editing position I GPQSK[editpos]
   Current trigger list(s) (one per trigger list identifier) n (3xI) GPQITS[ltrigs]
For Every Logical Input Device of Class Valuator:  
   Operating mode 
   (REQUEST, PRELE, EVENT)
 E GPQVL[mode]
   Echo switch 
   (NOECHO, ECHO)
 E GPQVL[echosw]
   Prompt and echo type I GPQVL[echo]
   Current echo area (DC) 6xR GPQVL[area]
   Length of valuator data record I GPQVL[datalen]
   Current valuator data record I GPQVL[data]
   Current input character set identifier I GPQICS[cisd]
   Current initial value R GPQVL[ivalue]
   Current range low value R GPQVL[lovalue]
   Current range high value R GPQVL[hivalue]
   Current trigger list(s) (one per trigger list identifier) n (3xI) GPQITS[ltrigs]
For Every Logical Input Device of Class Choice:  
   Operating mode 
   (REQUEST, PRELE, EVENT)
 E GPQCH[mode]
   Echo switch 
   (NOECHO, ECHO)
 E GPQCH[echosw]
   Prompt/echo type E GPQCH[echo]
   Current echo area (DC) 6xR GPQCH[area]
   Length of choice data record I GPQCH[datalen]
   Current choice data record   GPQCH[data]
   Current input character set identifier I GPQICS[csid]
   Initial choice number I GPQICS[choice]
   Current trigger list(s) (one per trigger list identifier) n (3xI) GPQITS[ltrigs]
For Every Logical Input Device of Class Pick:  
   Operating mode 
   (REQUEST, PRELE, EVENT)
 E GPQPK[mode]
   Echo switch 
   (NOECHO, ECHO)
 E GPQPK[echosw]
   Prompt and echo type I GPQPK[echo]
   Current echo area (DC) 6xR GPQPK[area]
   Length of pick data record I GPQPK[datalen]
   Current pick data record   GPQPK[data]
   Current input character set identifier I GPQICS[csid]
   Pick path order 
   (TOP_FIRST, BOTTOM_FIRST)
 E GPQPK[order]
   Current pick path depth I GPQPK[depth]
   Current pick path nxI GPQPK[pickpath]
   Pick aperture R GPQPKA[size]
   Pick selection criteria 
   (FIRST, LAST, ALL,
    FIRST_VISIBLE, LAST_VISIBLE, ALL_VISIBLE)
 E N/A
   Pick correlation state 
   (OFF, ON)
 E N/A
Pick Filters:  
   Number of classes in inclusion filter I GPQPK[inclen]
   List of classes in inclusion filter nxI GPQPK[incl]
   Number of classes in exclusion filter I GPQPK[exclen]
   List of classes in exclusion filter nxI GPQPK[excl]
   Current trigger list(s) (one per trigger list identifier) n (3xI) GPQITS[ltrigs]
For Every Logical Input Device of Class String:  
   Operating mode 
   (REQUEST, PRELE, EVENT)
 E GPQST[mode]
   Echo switch 
   (NOECHO, ECHO)
 E GPQST[echosw]
   Prompt and echo type I GPQST[echo]
   Current echo area (DC) 6xR GPQST[area]
   Length of string data record I GPQST[datalen]
   Current string data record   GPQST[data]
   Current input character set identifier I GPQICS[csid]
   Length of initial string I GPQST[strlen]
   Initial string S GPQST[string]
   Input buffer size I GPQST[buffer]
   Initial editing position I GPQST[editpos]
   Current trigger list(s) (one per trigger list identifier) n (3xI) GPQITS[ltrigs]

The graPHIGS API Error State List (ESL)

The Error State List provides information on the current graPHIGS API error state.

The right-hand column lists the inquiry function that you can use when you want your application to know the error states of the system.

Data Type Field

The following correspondence applies to the abbreviated data types:

Data Type Definition
I Integer A whole number
R Real A floating-point number
S String A character string
E Enumeration A data type comprised of a set of values. The set is defined by enumerating the identifiers denoting the values.
n Quantity This specifies an undesignated quantity of data.
Note: The notation of n (number) x t (data type) indicates a collection of data of that type. This can be indicated in one of two ways:
  1. by using notation such as 3xR (three real numbers), which could specify something like the x, y, and z coordinates of a three-dimensional point or RGB values
  2. by using a variable number such as nxI, which specifies a collection of n integers.
Description of Field Data Type Inquiry
   Error state 
   (OFF, ON)
 E N/A
   Error reporting mode 
   (OFF, ON)
 E GPQEMO[mode]
Error File:  
   Name S (passed on GPOPPH)
Information of Last Error:  
   Workstation identifier I (passed to User Error Handler)
   Message number I GPQEMS[number]
   Message text S GPQEMS[message]

Utility Function State List (USL)

Utility functions aid in the definition of transformation viewing matrices. The USL is a temporary storage facility.

Data Type Field

The following correspondence applies to the abbreviated data types:

Data Type Definition
I Integer A whole number
R Real A floating-point number
S String A character string
E Enumeration A data type comprised of a set of values. The set is defined by enumerating the identifiers denoting the values.
n Quantity This specifies an undesignated quantity of data.
Note: The notation of n (number) x t (data type) indicates a collection of data of that type. This can be indicated in one of two ways:
  1. by using notation such as 3xR (three real numbers), which could specify something like the x, y, and z coordinates of a three-dimensional point or RGB values
  2. by using a variable number such as nxI, which specifies a collection of n integers.
Description of Field Data Type Inquiry
View reference point (WC) 3xR N/A
View plane normal (WC) 3xR N/A
View up (WC) 3xR N/A
[ Previous | Next | Contents | Glossary | Home | Search ]