RETRIEVE STRUCTURES(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

RETRIEVE STRUCTURES − retrieve specified structures from an archive file

SYNOPSIS

C Syntax

void
pret_structs ( archive_id, struct_ids )
Pintarchive_id;archive identifier
Pint_list∗struct_ids;list of structure identifiers

Required PHIGS Operating States

(PHOP, ∗, ∗, AROP)

DESCRIPTION

Purpose

Use RETRIEVE STRUCTURES to retrieve a list of structures from the specified open archive file into the CSS.

C Input Parameters

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

struct_ids
A pointer to a Pint_list structure containing the list of structure identifiers to be retrieved. The Pint_list structure 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.

Execution

The specified structures are copied from the indicated open archive file into the Central Structure Store (CSS). If any of the structures to be retrieved currently exist in the CSS, the conflict is resolved as follows:

•If the retrieval conflict resolution flag is MAINTAIN, then the conflicting structure will not be copied into the CSS (its contents are maintained).

•If the retrieval conflict resolution flag is UPDATE, then the conflicting structure in the CSS will be overwritten (its contents are updated).

•If the retrieval conflict resolution flag is ABANDON, then no structures will be copied to the CSS.

The retrieval conflict resolution flag is set by the SET CONFLICT RESOLUTION subroutine.

If the currently open structure must be overwritten because of a conflict while the retrieval conflict resolution flag is UPDATE, then it is closed, its contents are overwritten, and it is re-opened. The element pointer will be set to point to the last element.

If any of the structures to be retrieved do not exist in the archive file, then an empty structure is created in the CSS, a warning is generated, and the retrieval operation continues for the remaining structures.

ERRORS

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

404Ignoring function, the specified archive file is not open

405Ignoring function, name conflict occurred while conflict resolution flag has value ABANDON

408Warning, some of the specified structures do not exist on the archive file. PHIGS will create empty structures in their places

Museum