Get a description of a collection category¶
saf_describe_category
is a function defined in cat.c.
Synopsis:
Formal Arguments:
cat
: A collection category handle.name
: If non-NULL
, the returned name of the collection category (see *Returned Strings*).role
: If non-NULL
, the returned role of the collection category (see *Collection Roles*).tdim
: If non-NULL
, the returned maximum topological dimension of members of collections of this category.
Description: This call describes a collection category.
Preconditions:
pmode
must be valid. (low-cost)cat
must be a valid category handle. (low-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.
Parallel Notes: This call must be collective across the database communicator in which the category is defined.
See Also:
- Collection Categories: Introduction for current chapter