graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPARST - Archive Structures

GPARST (arid, number, lstrid)

Purpose

Use GPARST to store one or more structures from the currently selected structure store into the specified open archive file.

If any of the specified structures do not exist in the currently selected structure store, then the graPHIGS API issues a warning and no action is taken for the non-existing structures. If one of the specified structures already exists in the archive file, then the graPHIGS API resolves the conflict according to the value of the archive conflict resolution flag specified by the Set Conflict Resolution (GPCNRS) subroutine.

If an error occurs during the archival process, then the graPHIGS API issues a message and terminates the archival process. Any structures that were successfully transferred to the archive file are archived in their entirety.

Note:

The graPHIGS API empties the structure in the archive file before it copies the source structure. If an error occurs (such as, the copying of a structure cannot be completed), then the graPHIGS API cannot reconstruct the original structure.

Currently, the archive file resource and structure store must reside on the same nucleus. If the two resources are on different nuclei, then the graPHIGS API issues error 1109

Parameters

arid -- specified by user, fullword integer

Archive file identifier.

number -- specified by user, fullword integer

Number of structure identifier entries in the list (>=1)

lstrid -- specified by user, array of fullword integers

List of structure identifiers.

Error Codes

7: FUNCTION REQUIRES STATE AROP
12: FUNCTION REQUIRES STATE SSSL
120: WARNING, ONE OR MORE STRUCTURES DO NOT EXIST
128: STRUCTURE CONFLICT OCCURS WHEN RESOLUTION FLAG IS ABANDON
134: NUMBER OF ENTRIES IN LIST < ONE
220: SPECIFIED ARCHIVE FILE DOES NOT EXIST
594: DATA EXCEEDS CONNECTION BUFFER SIZE
614: UNKNOWN ELEMENT FOUND IN STRUCTURE n1
1109: FUNCTION NOT SUPPORTED
1113: FILE IS READ ONLY

Related Subroutines

GPARAS: Archive All Structures
GPARSN: Archive Structure Networks
GPCNRS: Set Conflict Resolution

RCP code

201348612 (X'0C005604')