The graPHIGS Programming Interface : Subroutine Reference

Chapter 16. Inquire Subroutines

Inquiry programming subroutines allow application programs to obtain the following information:

Default system characteristics

Current state of the system

Default workstation characteristics

Current state of a workstation

Configuration of a workstation

Structure existence and relationships

Structure content

Nucleus characteristics

Error state and message content

For all inquire subroutines, the parameters listed prior to the errind parameter are specified by the user; errind and the parameters which follow are returned by the graPHIGS API

WSL Inquiries

The subroutines in this section have a first parameter of workstation identifier (wsid) These subroutines inquire information from the Workstation State List (WSL) corresponding to the specified workstation identifier. The WSL contains the current state of the workstation. To inquire the general characteristics and capabilities of the workstation type, see "WDT Inquiries"

GPQAR: Inquire Set of Associated Roots
GPQBKS: Inquire Break Action State
GPQCCH: Inquire Color Table Characteristics
GPQCH: Inquire Choice Device State
GPQCID: Inquire List of Color Table Identifiers
GPQCML: Inquire Color Model
GPQCPR: Inquire Color Processing Representation
GPQCSR: Inquire Cull Size Representation
GPQCVE: Inquire Current View Table Entries Input
GPQCVO: Inquire Current View Table Entries Output
GPQCVR: Inquire Current View Representation
GPQDMR: Inquire Data Mapping Representation
GPQDCR: Inquire Depth Cue Representation
GPQDV: Inquire Deferral and Update State Values
GPQFO: Inquire Active Fonts
GPQGFC: Inquire Geometric Font Characteristics
GPQHLF: Inquire Highlighting Filter
GPQHR: Inquire Hatch Representation
GPQICH: Inquire Image Characteristics
GPQICS: Inquire Input Character Set
GPQID: Inquire Input Device State
GPQIMC: Inquire Image Mapping Characteristics
GPQIMI: Inquire Image Mapping of Image
GPQIMV: Inquire Image Mapping on View
GPQIMW: Inquire Image Mapping on Workstation
GPQITS: Inquire Input Device Trigger State
GPQIVF: Inquire Invisibility Filter
GPQIW: Inquire List of Images on the Workstation
GPQLC: Inquire Locator Device State
GPQLSR: Inquire Light Source Representation
GPQLTR: Inquire Linetype Representation
GPQMDS: Inquire Mapped Display Surface Size
GPQMTR: Inquire Marker Type Representation
GPQPAR: Inquire Pattern Representation
GPQPK: Inquire Pick Device State
GPQPKA: Inquire Pick Aperture
GPQRCT: Inquire Realized Connection Type
GPQRV: Inquire Set of Roots in View
GPQRVE: Inquire Requested View Table Entries Input
GPQRVO: Inquire Requested View Table Entries Output
GPQRVR: Inquire Requested View Representation
GPQSK: Inquire Stroke Device State
GPQST: Inquire String Device State
GPQVL: Inquire Valuator Device State
GPQVR: Inquire Set of Views Which Contain Root
GPQWSU: Inquire Workstation Storage Utilization
GPQWSX: Inquire Workstation Transformation
GPQXAF: Inquire Extended Annotation Font Characteristics
GPQXCR: Inquire Extended Color Representation
GPQXER: Inquire Extended Edge Representation
GPQXIR: Inquire Extended Interior Representation
GPQXLR: Inquire Extended Polyline Representation
GPQXMR: Inquire Extended Polymarker Representation
GPQXTR: Inquire Extended Text Representation

WDT Inquiries

Subroutines with a first parameter of workstation type (wstype) inquire information from the Workstation Description Table (WDT) corresponding to the specified workstation type. For each workstation you may inquire information from its generic or actual descriptor table. The generic descriptor table contains the maximum capabilities of the workstation, whereas the actual descriptor table contains the realized capabilities of the workstation after it is opened. To be able to inquire the realized capabilities of a workstation, you must supply the realized workstation type on the inquiry. Use the Inquire Realized Connection and Type (GPQRCT) subroutine to obtain the realized workstation type.

GPQAAF: Inquire Advanced Attribute Facilities
GPQAMO: Inquire Available Antialiasing Modes
GPQANF: Inquire Annotation Facilities
GPQART: Inquire Rendering Targets
GPQBK: Inquire Break Capabilities
GPQCDF: Inquire Curve Display Facilities
GPQCF: Inquire Color Facilities
GPQCPF: Inquire Color Processing Facilities
GPQCQM: Inquire Available Color Quantization Methods
GPQCSF: Inquire Cull Size Facilities
GPQCUF: Inquire Cursor Facilities
GPQDBK: Inquire Default Break Action
GPQDCF: Inquire Depth Cue Facilities
GPQDCH: Inquire Default Choice Device Data
GPQDDV: Inquire Default Deferral State Values
GPQDIT: Inquire Default Input Device Triggers
GPQDLC: Inquire Default Locator Device Data
GPQDPK: Inquire Default Pick Device Data
GPQDS: Inquire Maximum Display Surface Size
GPQDSK: Inquire Default Stroke Device Data
GPQDST: Inquire Default String Device Data
GPQDVL: Inquire Default Valuator Device Data
GPQEF: Inquire Edge Facilities
GPQES: Inquire List of Available Escape Subroutines
GPQFBC: Inquire Frame Buffer Characteristics
GPQFP: Inquire Font Pool Size
GPQGD: Inquire List of Generalized Drawing Primitives
GPQGDP: Inquire Generalized Drawing Primitive
GPQGSE: Inquire List of Available GSEs
GPQHD: Inquire Maximum Hierarchy Depth
GPQHF: Inquire Hatch Facilities
GPQHMO: Inquire Available HLHSR Modes
GPQIDD: Inquire Input Device Description
GPQIDF: Inquire Image Definition Facilities
GPQIF: Inquire Interior Facilities
GPQIMF: Inquire Image Mapping Facilities
GPQISF: Inquire Input Character Set Facilities
GPQIT: Inquire Input Trigger Capabilities
GPQLCF: Inquire List of Color Facilities
GPQLI: Inquire List of Logical Input Devices
GPQLNR: Inquire List of Line Rendering Styles
GPQLSF: Inquire Light Source Facilities
GPQLTF: Inquire Linetype Facilities
GPQLW: Inquire Length of Workstation State Tables
GPQMTF: Inquire Marker Type Facilities
GPQNCN: Inquire Number of Available Class Names
GPQNSP: Inquire Number of Structure Priorities Supported
GPQNST: Inquire Number of Secondary Triggers
GPQNV: Inquire Number of Definable View Table Entries
GPQPAF: Inquire Pattern Facilities
GPQPCR: Inquire Predefined Color Representation
GPQPCS: Inquire Primary Character Set
GPQPDC: Inquire Physical Device Characteristics
GPQPER: Inquire Predefined Edge Representation
GPQPIR: Inquire Predefined Interior Representation
GPQPKT: Inquire Pick Measure Type
GPQPLF: Inquire Polyline Facilities
GPQPLR: Inquire Predefined Polyline Representation
GPQPMF: Inquire Polymarker Facilities
GPQPMR: Inquire Predefined Polymarker Representation
GPQPPR: Inquire Predefined Pattern Representation
GPQPTR: Inquire Predefined Text Representation
GPQRCM: Inquire Available Rendering Color Models
GPQSDF: Inquire Surface Display Facilities
GPQSPD: Inquire Source Physical Device
GPQTDF: Inquire Trimming Curve Display Facilities
GPQTMO: Inquire Available Transparency Modes
GPQVF: Inquire View Facilities
GPQWC: Inquire Workstation Category
GPQWD: Inquire Workstation Display Classification
GPQWDT: Inquire Workstation Description
GPQWTO: Inquire Workstation Type and Options
GPQXCF: Inquire Extended Color Facilities
GPQXTX: Inquire Extended Text Facilities

PDT Inquiries

The subroutines in this section inquire information from the graPHIGS API Shell Description Table (PDT)

The PDT contains information describing the general capabilities of the graPHIGS API

GPQAI: Inquire List of Available Application Image Formats
GPQCMM: Inquire List of Available Connection Methods

PSL Inquiries

The subroutines in this section inquire information about the state of the graPHIGS API shell from the graPHIGS API State List (PSL)

The PSL contains the dynamic (variable) workstation-independent state of the graPHIGS API

GPQASV: Inquire Archive State Value
GPQATR: Inquire List of Attached Resources
GPQCEV: Inquire Current Event
GPQCNC: Inquire List of Connected Nuclei
GPQCS: Inquire Character Set Identifier
GPQDCM: Inquire Direct Color Model
GPQEDM: Inquire Edit Mode
GPQEMO: Inquire Error Handling Mode
GPQEMS: Inquire Error Message
GPQFAR: Inquire Font Aspect Ratios
GPQFCH: Inquire Font Characteristics
GPQIBC: Inquire Image Board Characteristics
GPQIQO: Inquire Input Queue Overflow
GPQNCC: Inquire Nucleus Connection State
GPQNCR: Inquire Nucleus Resource Identifier
GPQOPW: Inquire Set of Open Workstations
GPQSEV: Inquire More Simultaneous Events
GPQSH: Inquire Shell Identifier
GPQSHD: Inquire Shell Deferral State
GPQSPL: Inquire Shell Product Level
GPQSSS: Inquire Selected Structure Store
GPQSTV: Inquire Structure State Value
GPQSYV: Inquire System State Value
GPQWSV: Inquire Workstation State Value

NDT Inquiries

The subroutines in this section inquire information from the Nucleus Description Table (NDT)

The NDT contains information describing the general capabilities of the nucleus conected to the graPHIGS API shell.

GPQIBF: Inquire Image Board Facilities
GPQNCE: Inquire Nucleus Environment
GPQNS: Inquire Nucleus Specification
GPQPO: Inquire Available Pixel Operations
GPQWTN: Inquire List of Available Workstation Types on Nucleus

NSL Inquiries

The subroutines in this section inquire information from the Nucleus State List (NSL)

The NSL contains the dynamic (variable) states of the nucleus connected to the graPHIGS API shell.

GPQNCS: Inquire Available Nucleus Storage Size

SSL Inquiries

The subroutines in this section inquire information from the Structure State List (SSL) about the state of the structure store that exists in the nucleus connected to the graPHIGS API shell.

The following information can be inquired:

current structure element pointers

the currently open structure

if a structure is in the SSL

all the structures in the SSL

structures executed by a structure

the structure elements in a structure

contents of a structure element

workstations associated with a structure

list of structures that conflict between different structure stores

ancestor/descendant path data

GPELS: Element Search
GPQACS: Inquire All Conflicting Structures in Structure Store
GPQCSN: Inquire Conflicting Structures in Network in Structure Store
GPQED: Inquire List of Element Data
GPQEDA: Inquire List of Element Data for any Structure
GPQEHA: Inquire List of Element Headers for any Structure
GPQEHD: Inquire List of Element Headers
GPQEP: Inquire Element Pointer
GPQEXS: Inquire Executed Structures
GPQISN: Inquire Identifiers of Structures in Network
GPQOPS: Inquire Open Structure
GPQPAS: Inquire Ancestors of Structure
GPQPDS: Inquire Descendents of Structure
GPQRST: Inquire Referencing Structures
GPQSTI: Inquire Structure Identifiers
GPQSTS: Inquire Structure Status
GPQWSA: Inquire Set of Workstations to Which Associated

Archive Inquiries

The subroutines in this section inquire archive information from the structure store and the archive files.

With these subroutines, you can retrive the following information:

list of structures in the archive file

list of structures that conflict between the specified archive file and the currently selected structure store

list of open archive files

the conflict resolution flags

ancestor/descendant path data

GPQACA: Inquire All Conflicting Structures in Archive
GPQARF: Inquire Archive Files
GPQCNA: Inquire Conflicting Structures in Network in Archive
GPQCNR: Inquire Conflict Resolution
GPRAS: Retrieve Ancestors to Structures
GPRDS: Retrieve Descendants to Structures
GPRISN: Retrieve Identifiers of Structures in Network
GPRSTI: Retrieve Structure Identifiers

GPELS - Element Search

GPELS (strid, start, direction, inclnum, lincl, exclnum, lexcl, errind, status, position, header)

Note:

This subroutine is a Structure State List (SSL) inquiry. For an overview, see "SSL Inquiries"

Purpose

Use GPELS to search through a specified structure for an element that matches a given criteria. The search starts at a specified element position and searches in a designated direction until either an element is found that matches the criteria or until the limits of the structure are reached.

Search criteria

An element is selected if the element code is in the element inclusion list and not in the element exclusion list.

Element exclusion

An element is excluded if the element code is either not in the inclusion list or it is in the exclusion list.

Starting search position

The search starts at element position of zero if the specified starting position is less than zero. The search starts with the last element in the structure, if the specified starting position is larger than the number of elements in the structure.

If the search is successful, the application sets the status indicator to 2=SUCCESS , the element position is returned in the position parameter, and the element type and size is returned in the header parameter. Otherwise, the application sets the status indicator to 1=FAILURE and the values returned in the position and header parameters are unpredictable.

If the information is available, the error indicator is set to zero and the values are put into the output parameters. If the information is unavailable, the error indicator contains an error number indicating the reason. In this case, the values returned in the output parameters are unpredictable.

For the valid structure element codes used by the graPHIGS API see The graPHIGS Programming Interface: Technical Reference You can use the following two additional element codes in the inclusion and exclusion lists for this subroutine:

Decimal	Hex	Description
0	0000	Represents element position zero.
65535	FFFF	Represents all elements.

Parameters

strid -- specified by user, fullword integer

Structure identifier.

start -- specified by user, fullword integer

The position of the element to begin the search.

direction -- specified by user, fullword integer

Search direction (1=BACKWARD, 2=FORWARD )

inclnum -- specified by user, fullword integer

The number of element codes in the inclusion list (>=0)

lincl -- specified by user, array of fullword integers

A list of element codes to be included in the inclusion list.

exclnum -- specified by user, fullword integer

The number of element codes in the exclusion list (>=0)

lexcl -- specified by user, array of fullword integers

A list of element codes to be included in the exclusion list.

errind -- specified by user, fullword integer

Error indicator. If the error indicator is zero, the request has been completed. Otherwise, one of the following errors exists:

12: FUNCTION REQUIRES STATE SSSL
122: STRUCTURE IDENTIFIER DOES NOT EXIST
528: DIRECTION VALUE IS INVALID
529: NUMBER OF ENTRIES IN INCLUSION OR EXCLUSION LIST < ZERO

status -- returned by the graPHIGS API, fullword integer

Status indicator which indicates the results of the search (1=FAILURE, 2=SUCCESS )

position -- returned by the graPHIGS API, fullword integer

Position of the element found in the search.

header -- returned by the graPHIGS API, fullword integer

Element header of the element found in the search. The first halfword contains the length of the element and the second halfword contains the element code. The information that corresponds to each element header and the list of valid structure element codes used by graPHIGS API are found in The graPHIGS Programming Interface: Technical Reference

Error Codes

None

Related Subroutines

None

RCP code

201347587 (X'0C005203')