Creates a region reference
Procedure:
H5R_CREATE_REGION ( loc_id, name, space_id, oapl_id, ref_ptr )
Signature:
herr_t H5Rcreate_region ( hid_t loc_id, const char *name, hid_t space_id, hid_t oapl_id, H5R_ref_t *ref_ptr )
Parameters:
hid_t loc_id | IN: Location identifier |
const char * name | IN: Name of object |
hid_t space_id | IN: Dataspace identifier |
hid_t oapl_id | IN: Valid object access property list identifier |
H5R_ref_t *r ef_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_REGION creates the reference, ref_ptr, pointing to the region represented by space_id within the object named name located at loc_id.
The parameters loc_id and name are used to locate the object. The parameter space_id identifies the dataset region that a dataset region reference points to.
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 dataset property list in this case.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.12.0 | C function was introduced in this release. |
--- Last Modified: December 03, 2019 | 02:14 PM
