graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQALF - Inquire Actual Polyline Facilities

GPQALF (wsid, start, number, errind, ntype, ltype, nlwidth, lwidth, minlw, maxlw)

Purpose

Use GPQALF to inquire the actual polyline facilities for the specific workstation.

The values returned by the graPHIGS API indicate the total quantity of available linetypes, the specific supported linetypes, and the total quantity of available line widths and their minimum and maximum values. The returned widths of the line are in Device Coordinates 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 linetypes (>=1)

number -- specified by user, fullword integer

Number of linetypes requested (>=0)

errind -- returned by the graPHIGS API, fullword integer

If the error indicator is zero, the request was 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 linetypes.

ltype -- returned by the graPHIGS API, array of fullword integers.

Specifies an index into the workstation's available line type table. The table size and specific entries are workstation dependent. The default available 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.

nlwidth -- returned by the graPHIGS API, fullword integer

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

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

Nominal line width.

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

Minimum line width.

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

Maximum line width.

Error Codes

None

Related Subroutines

GPQPLF: Inquire Polyline Facilities
GPQRCT: Inquire Realized Connection Type

RCP code

201336583 (X'0C002707')