Query attribute metadata¶
ss_attr_describe
is a function defined in ssattr.c.
Synopsis:
-
const char *
ss_attr_describe
(ss_attr_t *attr, ss_pers_t *owner, hid_t *type, size_t *nelmts)¶
Formal Arguments:
attr
: The attribute to be described.owner [OUT]
: Optional object to which attribute belongs.type [OUT]
: Optional datatype of attribute data. The caller should invokenelmts [OUT]
: Optional number of elements stored by the attribute.
Description: This is really just a convenience function so if the caller wants the attribute datatype they don’t need to
do the work of calling H5decode
on the attribute type
field.
- Return Value: Returns the attribute name on success; null on failure. The name is simply the ss_string_ptr value of the
name
field of the attribute.
Parallel Notes: Independent
See Also:
- ss_string_ptr: 9.2: Obtain pointer into string object
- Object Attributes: Introduction for current chapter