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

NAME

INQUIRE PREDEFINED TEXT REPRESENTATION − inquire a predefined text representation for a workstation type

SYNOPSIS

C Syntax

void
pinq_pred_text_rep ( type, index, error_ind, bundle )
Pinttype;workstation type
Pintindex;predefined index
Pint∗error_ind;OUT error indicator
Ptext_bundle∗bundle;OUT predefined text rep

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE PREDEFINED TEXT REPRESENTATION to determine the predefined text representation for a specified workstation type at a given text index.

C Input Parameters

type
Type of workstation.

index
Entry to be returned from the workstation table of predefined text representations.

C Output Parameters

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

bundleA pointer to a Ptext_bundle structure, in which the system returns the text representation at index in the workstation table of predefined text representations. Ptext_bundle is defined in phigs.h as:

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,/∗ string precision ∗/
PPREC_CHAR,/∗ character precision ∗/
PPREC_STROKE/∗ stroke precision ∗/
} 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

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

051Ignoring function, this information is not yet available for this workstation type; open a workstation of this type and use the specific workstation type

052Ignoring function, workstation type not recognized by the implementation

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

062Ignoring function, this information is not available for this MO workstation type

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

102Ignoring function, the specified representation has not been predefined on this workstation

Museum