[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface : Subroutine Reference

GPTST - Transfer Structures

GPTST (ssid, flag, number, lstrid)

Purpose

Use GPTST to copy one or more structures from a specified structure store to the currently selected structure store. Both the source and target structure stores can reside on the same or different nuclei. If the specified structure store is the currently selected structure store, then no action is taken.

If any of the specified structures do not exist in the specified structure store and the specified structure identifier does not exist in the current structure store, then the graPHIGS API issues a warning and creates an empty structure. If any of the specified structures do not exist in the specified structure store and the specified structure identifier does exist in the current structure store and the conflict resolution flag is set to 3=UPDATE , then the graPHIGS API issues a warning and empties the structure.

If one of the specified structures already exists in the currently selected structure store, then the graPHIGS API resolves the conflict according to the conflict resolution flag. If there is a conflict and the resolution flag is set to 1=MAINTAIN , the graPHIGS API only transfers structures that do not conflict and there is no change to any existing structure. When the conflict resolution flag is set to 2=ABANDON , the graPHIGS API does not transfer any structures and issues an error. When the flag is set to 3=UPDATE , the graPHIGS API transfers every structure. The conflicting structure replaces the new one without changing any associations to a workstation or view.

Note:

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

When you replace a structure that is an open structure, the structure remains open and is emptied, but the graPHIGS API does not remove references to the structure. The result is as though you had issued the following:

  1. GPCLST - Close Structure

  2. GPEST - Empty Structure

  3. GPTST - Transfer Structures

  4. GPOPST - Open Structure
  5. If your application transfers an execute structure-type element that refers to a non-existing structure, then the graPHIGS API creates an empty structure.

    Parameters

    ssid -- specified by user, fullword integer

    Structure store identifier.

    flag -- specified by user, fullword integer

    Conflict resolution flag (1=MAINTAIN, 2=ABANDON, 3=UPDATE )

    number -- specified by user, fullword integer

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

    lstrid -- specified by user, array of fullword integers

    A list of structure identifiers.

    Error Codes

    12
    FUNCTION REQUIRES STATE SSSL
    120
    WARNING, ONE OR MORE STRUCTURES DO NOT EXIST
    127
    CONFLICT RESOLUTION FLAG IS INVALID
    128
    STRUCTURE CONFLICT OCCURS WHEN RESOLUTION FLAG IS ABANDON
    134
    NUMBER OF ENTRIES IN LIST < ONE
    222
    SPECIFIED STRUCTURE STORE DOES NOT EXIST
    594
    DATA EXCEEDS CONNECTION BUFFER SIZE
    614
    UNKNOWN ELEMENT FOUND IN STRUCTURE n1

    Related Subroutines

    GPTAST
    Transfer All Structures

    RCP code

    201348609 (X'0C005601')


    [ Previous | Next | Contents | Glossary | Home | Search ]