RETRIEVE ALL STRUCTURES(3P) — SUNPHIGS LIBRARY

NAME

RETRIEVE ALL STRUCTURES − retrieve all structures from an archive file

SYNOPSIS

C Syntax

void
pretrieveallstruct ( archive_id )
Pintarchive_id;archive identifier

FORTRAN Syntax

SUBROUTINE prast ( AFID )
INTEGERAFIDarchive file identifier

Required PHIGS Operating States

(PHOP, ∗, ∗, AROP)

DESCRIPTION

Purpose

Use RETRIEVE ALL STRUCTURES to retrieve all structures from the specified open archive file into the Central Structure Store.

C Input Parameter

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

FORTRAN Input Parameter

AFIDThe archive identifier specifying the open archive file to read from.

Execution

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

• If the retrieval conflict resolution flag is MAINTAIN, the conflicting structure will not be copied into the Central Structure Store (its contents are maintained) • If the retrieval conflict resolution flag is UPDATE, the conflicting structure in the Central Structure Store will be overwritten (its contents are updated) • If the retrieval conflict resolution flag is ABANDON, no structures will be copied to the Central Structure Store at all.

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, it is closed, its contents are overwritten, and it is re-opened. The element pointer will be set to point to the last element.

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

Museum