Sets up a dataspace and selection as specified by a region reference
Procedure:
H5R_OPEN_REGION ( ref_ptr, rapl_id, oapl_id )
Signature:
hid_t H5Ropen_region ( H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id )
Parameters:
H5R_ref_t * ref_ptr | IN: Pointer to region reference to open
H5R_ref_t is defined in H5Rpublic.h as: typedef unsigned char H5R_ref_t[H5R_REF_BUF_SIZE]; |
hid_t rapl_id | IN: Valid reference access property list identifier |
hid_t oapl_id | IN: Valid object access property list identifier |
Description:
H5R_OPEN_REGION creates a copy of the dataspace of the dataset pointed to by a region reference, ref_ptr, and defines a selection matching the selection pointed to by ref_ptr within the dataspace copy.
The parameter rapl id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).
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 that case.
Use H5S_CLOSE to release the dataspace identifier returned by this function when the identifier is no longer needed.
Returns:
Returns a valid dataspace identifier if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.12.0 | C function introduced in this release. |
--- Last Modified: July 10, 2020 | 08:50 AM
