Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5R_CREATE_ATTR

Creates an attribute reference

Procedure:

H5R_CREATE_ATTR ( loc_id, name, attr_name, oapl_id, ref_ptr )

Signature:

herr_t H5Rcreate_attr ( hid_t loc_id, const char *name, const char *attr_name, hid_t oapl_id, H5R_ref_t *ref_ptr )

Parameters:
hid_t loc idIN: Location identifier
const char * nameIN: Name of object
const char * attr_nameIN: Name of attribute
hid_t oapl_idIN: Valid object access property list identifier 
H5R_ref_t * ref_ptr

OUT: Pointer to reference
H5R_ref_t is defined in H5Rpublic.h as:   typedef unsigned char H5R_ref_t[H5R_REF_BUF_SIZE];

Description:

H5R_CREATE_ATTR creates the reference, ref_ptr, pointing to the attribute named attr_name and attached to the object named name located at loc_id.

The parameters loc_id and name are used to locate the object. The parameter attr_name is used to locate the attribute within the object.

The parameter oapl_id is an object access property list identifier for the object that the referenced attribute is attached to. The access property list must be of the same type as that object, that is a group, dataset or committed datatype property list.

Returns:

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

Example:

None

History:
ReleaseChange
1.12.0C function was introduced in this release.

--- Last Modified: December 03, 2019 | 02:18 PM