Write an alternate index specs to disk¶
saf_write_alternate_indexspec
is a function defined in altindx.c.
Synopsis:
-
int
saf_write_alternate_indexspec
(SAF_ParMode pmode, SAF_AltIndexSpec *aspec, hid_t data_type, void *buf, SAF_Db *file)¶
Formal Arguments:
pmode
: The parallel mode.aspec
: The alternate index spec to write.data_type
: The datatype used to identify members of the collection, if not already supplied with saf_declare_alternate_indexspec.buf
: The buffer of data to write.file
: The optional destination file to which to write the data. If this is a null pointer then the data is written to the same file asaspec
.
Description: Write an alternate index specs to disk, involves actual I/O
Preconditions:
pmode
must be valid. (low-cost)aspec
must be a valid alternate index spec handle. (low-cost)buf
must not be null. (low-cost)- You must pass a datatype either in the call to saf_declare_alternate_indexspec or here. (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:
- saf_declare_alternate_indexspec: 30.1: Declare an Alternative Index Specification
- Alternative Index Specification: Introduction for current chapter