NAME

INQUIRE TEXT FACILITIES − inquire list of workstation text facilities

SYNOPSIS

C Syntax

void
pinq_text_facs ( type, length, start, error_ind, facilities, total_length )
Pinttype;workstation type
Pintlength;length of application list
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Ptext_facs∗facilities;OUT text facilities
Pint∗total_length;OUT length of list in PHIGS

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE TEXT FACILITIES to obtain a list of the text facilities available on the specified workstation type. 

C Input Parameters

typeWorkstation type. 

lengthThe length is the number of text font and precision (fps) pairs which the facilities output parameter can return in the allocated memory space.  A length of zero may be specified in order to have total_length return the total number of elements in the workstation list of available font and precision pairs. 

startStarting position in the list of font and precision pairs in the workstation description table at which to begin the inquiry. 

C Output Parameters

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

facilities
A pointer to a Ptext_facs data structure in which the system returns a listing of the text facilities available on this type of workstation. Ptext_facs is defined in phigs.h as:

typedef struct {
Pintnum_font_precs;/∗ number of fonts and precisions ∗/
Ptext_font_prec∗font_precs; /∗ list of fonts and precisions ∗/
Pintnum_char_hts;/∗ number of character heights ∗/
Pfloatmin_char_ht;/∗ minimum height ∗/
Pfloatmax_char_ht;/∗ maximum height ∗/
Pintnum_char_expans;/∗ number of character expansion factors ∗/
Pfloatmin_char_expan;/∗ minimum expansion factor ∗/
Pfloatmax_char_expan; /∗ maximum expansion factor ∗/
Pintnum_pred_inds;/∗ number of predefined bundles ∗/
} Ptext_facs;

Ptext_font_prec is defined in phigs.h as follows:

typedef struct {
Pintfont;/∗ text font ∗/
Ptext_precprec;/∗ text precision ∗/
} Ptext_font_prec;

Ptext_prec is an enumerated type with the following values:

typedef enum {
PPREC_STRING,
PPREC_CHAR,
PPREC_STROKE
} Ptext_prec;

total_length
An integer pointer in which the system returns the total number of items in the list of available font and precision pairs on the workstation description table. This is the value required for length if all the items in the workstation list are to be returned. 

The application must allocate memory for the text facilities list of fonts and precisions. 

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 (that is, the workstation category is neither OUTPUT, OUTIN, nor MO)

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

SEE ALSO

INQUIRE PREDEFINED TEXT REPRESENTATION (3P)

September 02, 1992