Last modified: 12 October 2012
Name: H5Awrite
Signature:
herr_t H5Awrite(hid_t attr_id, hid_t mem_type_id, const void *buf )

Purpose:
Writes data to an attribute.

Description:
H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is written from buf to the file.

If mem_type_id is either a fixed-length or variable-length string, it is important to set the string length when defining the datatype. String datatypes are derived from H5T_C_S1 (or H5T_FORTRAN_S1 for Fortran codes), which defaults to 1 character in size. See H5Tset_size and “Creating variable-length string datatypes.”

Datatype conversion takes place at the time of a read or write and is automatic. See the Data Conversion section of The Data Type Interface (H5T) in the HDF5 User's Guide for a discussion of data conversion, including the range of conversions currently supported by the HDF5 libraries.

Parameters:
hid_t attr_id IN: Identifier of an attribute to write.
hid_t mem_type_id     IN: Identifier of the attribute datatype (in memory).
const void *buf IN: Data to be written.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface: h5awrite_f

Fortran2003 Interface: h5awrite_f

See Also:
Creating variable-length string datatypes
H5Tset_size

History:
Release     Change
1.8.8 Fortran updated to Fortran2003.
1.4.2 Fortran dims parameter added in this release.