NAME

INQUIRE POLYLINE REPRESENTATION − inquire a polyline representation on a workstation

SYNOPSIS

C Syntax

void
pinq_line_rep ( ws, index, type, error_ind, rep )
Pintws;workstation identifier
Pintindex;polyline index
Pinq_typetype;type of returned value
Pint∗error_ind;OUT error indicator
Pline_bundle∗rep;OUT polyline representation

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE POLYLINE REPRESENTATION to determine the current attribute values for a specified entry in a specified workstation’s table of defined polyline representations. 

See the description of the subroutine SET POLYLINE REPRESENTATION for information on the meaning of these attribute values. 

C Input Parameters

wsWorkstation identifier. 

indexEntry to be returned from the workstation’s table of polyline representations; if this entry is not present in the table and the type of returned value parameter is REALIZED, the representation for polyline index 1 is returned. 

typeAn enumerated value specifying whether the inquired values are to be returned as the values originally specified by the application (SET), or as the values actually being used by the workstation if any of the application-specified values had to be mapped to ones available on the workstation (REALIZED).  Valid values are defined in phigs.h as:

PINQ_SETreturn application-specified value
PINQ_REALIZEDreturn value available on the workstation

C Output Parameters

error_ind
A pointer to the location to store the error number of any error detected by this function.

repA pointer to a Pline_bundle structure in which the system returns the polyline representation at index in the workstation’s table of polyline representations.  Pline_bundle is defined in phigs.h as follows:

typedef struct {
Pinttype;/∗ line type ∗/
Pfloatwidth;/∗ linewidth scale factor ∗/
Pintcolr_ind;/∗ colour index ∗/
} Pline_bundle;

Values for type are:

1PLINE_SOLID
2PLINE_DASH
3PLINE_DOT
4PLINE_DOT_DASH

Execution

If the inquired information is available, the error indicator is returned as zero and the requested information is returned in the output parameters. 

If the specified polyline index is not present in the polyline bundle table on the workstation and the specified type of returned value is Realized, the representation for polyline index one is returned. 

If the inquired information is not available, the values returned in the output parameters are undefined and the error indicator is set to one of the below error numbers to indicate the reason for non-availability. 

Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function. 

ERRORS

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open

059Ignoring function, the specified workstation does not have output capability (in other words, the workstation category is neither OUTPUT, OUTIN, nor MO)

100Ignoring function, the bundle index value is less than one

101Ignoring function, the specified representation has not been defined

SEE ALSO

SET POLYLINE REPRESENTATION (3P)
INQUIRE LIST OF POLYLINE INDICES (3P)
INQUIRE PREDEFINED POLYLINE REPRESENTATION (3P)
INQUIRE POLYLINE REPRESENTATION PLUS (3P+)

September 02, 1992