NAME

RETRIEVE STRUCTURE IDENTIFIERS − retrieve a list of structure identifiers from an archive file

SYNOPSIS

C Syntax

void
pret_struct_ids ( archive_id, max_ids, start, ids, actual_ids )
Pintarchive_id;archive identifier
Pintmax_ids;size of appl. archive id list
Pintstart;start position of ids
Pint_list∗ids;OUT list of structure ids
Pint∗actual_ids;OUT actual number of ids in PHIGS

Required PHIGS Operating States

(PHOP, ∗, ∗, AROP)

DESCRIPTION

Purpose

Use RETRIEVE STRUCTURE IDENTIFIERS to retrieve a list of the identifiers of all structures archived in the specified open archive file. 

C Input Parameters

archive_id
The archive identifier specifying the open archive file to read from.

max_ids
The number of ints items in the ids output parameter for which the application has allocated memory.  max_ids is the number of list elements (archive structure identifiers) that the system can return in integers.  If a value of 0 is used here, no data will be returned in the ints list, but the total number of structure identifiers in the archive file will be returned in actual_ids. 

startStarting position in the list of archive structure identifiers at which to begin the inquiry.  The elements of the list of structure identifiers, beginning with the item number specified by start,  are copied sequentially into ints until ints is full or all the structure identifiers have been copied. 

C Output Parameters

idsA pointer to a Pint_list structure in which the list of structure identifiers in the specified open archive file is returned.  The Pint_list structure is defined in phigs.h as follows:

typedef struct {
Pintnum_list;/∗ 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 max_ids elements in the ints list. 

actual_ids
A pointer to an integer in which the total number of structure identifiers in the specified archive file is returned. This is the value required for max_ids if all structure identifiers are to be returned. 

ERRORS

007Ignoring function, function requires state (PHOP, ∗, ∗, AROP)

404Ignoring function, the specified archive file is not open

SEE ALSO

OPEN ARCHIVE FILE (3P)
ARCHIVE STRUCTURES (3P)
INQUIRE ALL CONFLICTING STRUCTURES (3P)
SET CONFLICT RESOLUTION (3P)
RETRIEVE STRUCTURES (3P)
DELETE STRUCTURES FROM ARCHIVE (3P)

September 02, 1992