graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQAEF - Inquire Actual Edge Facilities

GPQAEF (wsid, start, number, errind, ntype, eltype, nelwidth, elwidth, minelw, maxelw)

Purpose

Use GPQAEF to inquire the actual edge facilities of the specified workstation.

The graPHIGS API returns values indicating the identifiers of the linetypes; the maximum quantity available; and the nominal, minimum, and maximum line width values. The line widths are returned in Device Coordinates (DC) for the specified workstation.

If the inquired information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. If the error indicator is 543 (the start value exceeds the extent of the available data), then only the total number (totnum) parameter is set. If the inquired information is unavailable, then the error indicator (errind) contains an error number indicating the reason, and the values returned in the output parameters are unpredictable.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

start -- specified by user, fullword integer

Starting member of the list of edge line types (>=1)

number -- specified by user, fullword integer

Number of edge line types requested (>=0)

errind -- returned by the graPHIGS API, fullword integer

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

25: SPECIFIED WORKSTATION DOES NOT EXIST
35: WORKSTATION HAS ONLY INPUT CAPABILITIES
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED

ntype -- returned by the graPHIGS API, fullword integer

Total number of available edge line types.

eltype -- returned by the graPHIGS API, array of fullword integers

Specifies an index into the workstation's edge line type table. The table size and specific entries supported are workstation dependent. The default edge line type table for supported entries is defined with the following line types: (1=SOLID_LINE, 2=DASHED, 3=DOTTED, 4=DASH_DOT, 5=LONG_DASH, 6=DOUBLE_DOT, 7=DASH_DOUBLE_DOT, 8-n=SOLID_LINE Any entry may be changed by the Set Linetype Representation (GPLTR) subroutine except entry 1)

The output array must be large enough to contain the requested data.

nelwidth -- returned by the graPHIGS API, fullword integer

Total number of available line widths of edges. (Zero means that the workstation supports a continuous range of line widths of edges)

elwidth -- returned by the graPHIGS API, short floating-point number (DC)

Nominal line width of edge.

minelw -- returned by the graPHIGS API, short floating-point number (DC)

Minimum line width of edge.

maxelw -- returned by the graPHIGS API, short floating-point number (DC)

Maximum line width of edge.

Error Codes

None

Related Subroutines

GPQEF: Inquire Edge Facilities
GPQRCT: Inquire Realized Connection Type

RCP code

201336596 (X'0C002714')