Add members to a collection¶
saf_extend_collection
is a function defined in coll.c.
Synopsis:
-
int
saf_extend_collection
(SAF_ParMode pmode, SAF_Set *containing_set, SAF_Cat *cat, int add_count, SAF_IndexSpec add_ispec)¶
Formal Arguments:
pmode
: The parallel mode.containing_set
: The containing set of the collection.cat
: The collection category of the collection.add_count
: The number of members to add to the collection.add_ispec
: The new indexing scheme.
Description: This function allows the client to add members to an existing collection. While you can extend a collection, you cannot change the number of dimensions in the indexing scheme. You can only change the size in each dimension and then you can only increase it. That is, if the collection was indexed using 2 dimensional indexing, it cannot be changed to 3 dimensional indexing.
Preconditions:
pmode
must be valid. (low-cost)containing_set
must be a valid set handle for participating processes. (low-cost)cat
must be a valid category handle for participating processes. (low-cost)add_ispec
sizes must be valid, totaladd_count
and be compatible with the existing indexing. (med-cost)
Return Value: The constant SAF__SUCCESS
is returned when this function is successful. Otherwise this function either returns
an error number or throws an exception, depending on the value of the library’s error handling property.
See Also:
- Collections: Introduction for current chapter