Manipulating individual containers

The ARGetListContainer function returns a list of containers that match specified criteria. The list contains only the names of the matching containers, not their reference lists and other attributes. To retrieve or modify individual containers, pass the name as an input argument to the ARGetContainer or ARSetContainer functions. Both of these functions and the ARCreateContainer function use the ARReferenceList structure to specify the objects referenced by a container. Guides reference active links. Applications reference schemas and other objects, both internal and external. 

Related topics

Developing-an-API-program

Data-structures

The ARReferenceList structure has zero or more ARReferenceStruct structures. See the following image:

Structures used to define container references
221_DataStructIcon10_ContRef.PNG

The ARReferenceStruct structure has the following elements:

Element

Description

Label

String that specifies a display-only label for the reference.

Its length is limited by ARMAX_CON_LABEL_LEN (255 bytes).

Description

String that specifies a display-only description for the reference.

Its length is limited by ARMAX_CON_DESCRIPTION_LEN (2000 bytes).

Type

Integer that specifies the type of reference represented by the structure (see the following table).

Values above 32767 define external reference types.

Reference

Union that defines an internal or external reference, depending on its Data Type, which is either 0 (ARREF_DATA_ARSREF) or 1 (ARREF_DATA_EXTREF).

Internal references (0) are specified in an ARInternalId structure. External references (1) are specified in an ARExtReferenceStruct structure (see the following figure).

Reference type values for ARReferenceStruct

The ARExtReferenceStruct structure (see the image Structures used to define container references) defines external references. This structure has the following elements:

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*