INQUIRE TEXT REPRESENTATION(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE TEXT REPRESENTATION − inquire a text representation on a workstation

SYNOPSIS

C Syntax

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

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

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

C Input Parameters

wsWorkstation identifier.

indexEntry to be returned from the workstation’s table of text representations; if this entry is not present in the table and the type of returned value parameter is REALIZED, the representation for text 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:

typedef enum {
PINQ_SET,/∗ Return Application-specified Value ∗/
PINQ_REALIZED /∗ Return Value Available on the Workstation ∗/
} Pinq_type;

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 Ptext_bundle structure in which the system returns the text representation at index in the workstation’s table of text representations. Ptext_bundle is defined in phigs.h as follows:

typedef struct {
Pintfont;/∗ text font ∗/
Ptext_precprec;/∗ text precision ∗/
Pfloatchar_expan;/∗ character expansion factor ∗/
Pfloatchar_space;/∗ character spacing ∗/
Pintcolr_ind;/∗ text colour index ∗/
} Ptext_bundle;

Ptext_prec is defined in phigs.h as:

typedef enum {
PPREC_STRING,
PPREC_CHAR,
PPREC_STROKE
} Ptext_prec;

Execution

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

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 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

Museum