xpfCreateAggrBN

 
SYNTAX:
 
xpfCreateAggrBN (instanceId    : GENERIC;
                 attributeName : STRING)                  newAggrId     : AGGREGATE OF GENERIC;
 
The xpfCreateAggrBN function creates an empty aggregate instance and connects the created aggregate to the specified attribute, <attributeName>, of the specified instance, <instanceId>.
A numeric aggregateID that uniquely identifies the new created aggregate instance, <newAggrId>, in the EDMdatabase^ will be the returned function value. This aggregateID should be used to identify this particular aggregate instance in subsequent EDMinterface^ operations. An aggregateID is persistent and fixed, i.e. it is constant throughout the lifetime of the actual aggregate instance.
The actual aggregate type to be created is defined by the attributed declaration in the related EXPRESS schema. If the actual attribute domain is a nested aggregate, only the first level, i.e., the outer-most aggregate is created. The other levels must be created by one of the following functions: xpxCreateNestedAggr, xpxCreateNestedAggrByIndex or xpxCreateNestedAggrByIterator.
If the actual attribute already owns an aggregate, the existing aggregate will be deleted before a new one is created by this function.
An aggregateID can never be used as a data value in any of the EDMinterface^ put operations, it can only be returned as data value in EDMinterface^ get operations.
This operation is only applicable to Explicit attributes in application instances.
The model that will hold the new created aggregate must be open for write access before this function can be successfully performed.
This function is equivalent to the EDMinterface^ function sdaiCreateAggrBN.
See also xpxCreateAggrBN.