NAME

INQUIRE POLYMARKER REPRESENTATION − inquire a polymarker representation on a workstation

SYNOPSIS

C Syntax

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

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

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

See the description of the subroutine SET POLYMARKER 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 polymarker representations; if this entry is not present in the table and the type of returned value parameter is REALIZED, the representation for polymarker 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 Pmarker_bundle structure in which the system returns the polymarker representation at index in the workstation’s table of polymarker representations.  Pmarker_bundle is defined in phigs.h as follows:

typedef struct {
Pinttype;/∗ marker type ∗/
Pfloatsize;/∗ marker size scale factor ∗/
Pintcolr_ind;/∗ colour index ∗/
} Pmarker_bundle;

Values for type are:

1PMARKER_DOT
2PMARKER_PLUS
3PMARKER_ASTERISK
4PMARKER_CIRCLE
5PMARKER_CROSS

Execution

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

If the specified polymarker index is not present in the polymarker bundle table on the workstation and the specified type of returned value is Realized, the representation for polymarker 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 following error numbers to indicate the reason for nonavailability. 

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 POLYMARKER REPRESENTATION (3P)
INQUIRE LIST OF POLYMARKER INDICES (3P)
INQUIRE PREDEFINED POLYMARKER REPRESENTATION (3P)
INQUIRE POLYMARKER REPRESENTATION PLUS (3P+)

September 02, 1992