Get a description of an alternate indexing spec¶
saf_describe_alternate_indexspec
is a function defined in altindx.c.
Synopsis:
-
int
saf_describe_alternate_indexspec
(SAF_ParMode pmode, SAF_AltIndexSpec *aspec, SAF_Set *containing_set, SAF_Cat *cat, char **name, hid_t *data_type, hbool_t *is_explicit, SAF_IndexSpec *implicit_ispec, hbool_t *is_compact, hbool_t *is_sorted)¶
Formal Arguments:
pmode
: The parallel modeaspec
: The alternate index spec you want the description of.containing_set
: [OUT
] The containing set of the collection. PassNULL
if you do not want this returned.cat
: [OUT
] The collection category. PassNULL
if you do not want this returned.name
: [OUT
] The name of this alt index spec.data_type
: [OUT
] The data type used to identify members of the collection. PassNULL
if you do not want this returned.is_explicit
: [OUT
] Whether the indexing specification is explicit or implicit.implicit_ispec
: [OUT
] The alternate indexing scheme of the collection. If the index spec is explicit, thenSAF__NA_INDEXSPEC
will be returned. If the index spec is implicit, the implicit index spec will be returned here.is_compact
: [OUT
] Whether the indexing specification is compact or not. Ignored for implicit specs.is_sorted
: [OUT
] Whether the indexing specification is sorted or not. Ignored for implicit specs.
Description: Get a description of an alternate indexing spec
Preconditions:
pmode
must be valid. (low-cost)- The
aspec
argument must be a valid 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.
See Also:
- Alternative Index Specification: Introduction for current chapter