Page tree

The license could not be verified: License Certificate has expired!

 

JAVA

FORTRAN

C++

C

 

Link

H5F_GET_INTENT

Determines the read/write or read-only status of a file

Procedure:

H5F_GET_INTENT(file_id, intent)

Signature:

herr_t H5Fget_intent( hid_t file_id, unsigned *intent )

Parameters:
hid_t file_idIN: File identifier for a currently-open HDF5 file
unsigned *intent   OUT: Intended access mode flag as originally passed with H5F_OPEN

Description:

Given the identifier of an open file, file_idH5F_GET_INTENT retrieves the “intended access mode” flag passed with H5F_OPEN when the file was opened. 

The value of the flag is returned in intent. Valid values are as follows:

H5F_ACC_RDWR File was opened with read/write access.
H5F_ACC_RDONLY File was opened with read-only access.
H5F_ACC_SWMR_WRITE   File was opened with read/write access for a single-writer/multiple-reader (SWMR) scenario. Note that the writer process must also open the file with the H5F_ACC_RDWR flag.
H5F_ACC_SWMR_READ File was opened with read-only access for a single-writer/multiple-reader (SWMR) scenario. Note that the reader process must also open the file with the H5F_ACC_RDONLY flag.

The function will not return an error if intent is NULL; it will simply do nothing.

Returns:

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

Example:

Coming soon!

History:
Release    Change
1.8.0C function introduced in this release.
1.10.0C function enhanced to work with SWMR functionality.

--- Last Modified: April 16, 2018 | 09:07 AM