NAME

INQUIRE STRUCTURE IDENTIFIERS− inquire the current structure identifiers

SYNOPSIS

C Syntax

void
pinq_struct_ids ( length, start, error_ind, struct_ids, length_list )
Pintlength;length of application list
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Pint_list∗struct_ids;OUT list of structure ids
Pint∗length_list;OUT length of list in PHIGS

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE STRUCTURE IDENTIFIERS to obtain a list of the current structure identifiers from the PHIGS state list. 

C Input Parameters

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

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

C Output Parameters

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

struct_ids
A pointer to a Pint_list structure in which the system returns the list of current structure identifiers. Pint_list is defined in phigs.h as follows:

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

The num_ints component specifies the number of structure identifiers in the list. The ints component is a pointer to a list, num_ints long, of the structure identifiers. 

The application must allocate memory for length elements in the struct_ids→ints list prior to calling this procedure. 

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 structure identifiers.  This is the value required for length if all structure identifiers are to be returned. 

ERRORS

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

SEE ALSO

CHANGE STRUCTURE IDENTIFIER (3P)
INQUIRE STRUCTURE STATUS (3P)

September 02, 1992