Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5R_CREATE_OBJECT

Creates an object reference

Procedure:

H5R_CREATE_OBJECT (loc_id, name, oapl_id, ref_ptr)

Signature:

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

Parameters:
hid_t loc_idIN: Location identifier
const char * nameIN: Name of object
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_OBJECT creates a reference pointing to the object named name located at loc_id. The parameters loc_id and name are used to locate the object.

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

Returns:

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

Example:

Include Bitbucket Server for Confluence: File content cannot be shown

Unauthenticated access to this resource is not allowed. Please login to Confluence first.

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

--- Last Modified: December 16, 2019 | 03:27 PM