NAME

INQUIRE HLHSR IDENTIFIER FACILITIES − inquire the available hidden line and hidden surface removal identifiers of a specified workstation type

SYNOPSIS

C Syntax

void
pinq_hlhsr_id_facs ( type, length, start, error_ind, ids, length_list )
Pinttype;workstation type
Pintlength;length of id list
Pintstart;starting position of id list
Pint∗error_ind;OUT error indicator
Pint_list∗ids;OUT list of HLHSR identifiers
Pint∗length_list;OUT length of id list in PHIGS

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE HLHSR IDENTIFIER FACILITIES obtains the available HLHSR (hidden line and hidden surface removal) identifiers on the specified workstation type.  See SET HLHSR IDENTIFIER for a description of how to set the id. 

type
Type of workstation.

length
The number of ints in the ids output parameter for which the application has allocated memory. length is the number of list elements that the system can return in ids→ints.  If a value of 0 is used here, no data will be returned in the ids→ints list, but the total number of identifiers in the PHIGS state list will be returned in length_list. 

start
Starting position of inquiry into the PHIGS state list of current identifiers. The elements of the list of identifiers, beginning with the item number specified by start, are copied sequentially into ids→ints until ids→ints is full or all the identifiers have been copied. 

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

ids
A pointer to a Pint_list data structure in which the system returns a list of the HLHSR identifiers available on this workstation type.  The returned list starts with the start item in the list of identifiers and returns the next length items.  Pint_list is defined in phigs.h as follows:

typedef struct {
Pintnum_ints;/∗ number of identifiers in list ∗/
Pint∗ints;/∗ list of identifiers ∗/
} Pint_list;

Prior to calling this function, the ints field must contain a pointer to an application supplied buffer.  This buffer must be able to hold length ids.  num_ints is the number of ids returned in the buffer.  Defined ids are:

0PHIGS_HLHSR_ID_OFFDo not do Hidden Line or Hidden Surface removal
1PHIGS_HLHSR_ID_ONDo Hidden Line and Hidden Surface removal
according to the current HLHSR Mode

length_list
A pointer to an integer in which the system returns the total number of elements in the PHIGS state list of currently used identifiers.  This is the value required for length if all identifiers are to be returned. 

ERRORS

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

052Ignoring function, workstation type not recognized by the implementation

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

057Ignoring function, specified workstation is of category MI

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

SEE ALSO

INQUIRE WORKSTATION CONNECTION AND TYPE (3P)
INQUIRE HLHSR MODE (3P)
INQUIRE HLHSR MODE FACILITIES (3P)
SET HLHSR MODE (3P)
SET HLHSR IDENTIFIER (3P)

September 02, 1992