Retrieves the external link traversal file access flag from the specified link access property list

Procedure:

H5P_GET_ELINK_ACC_FLAGS ( lapl_id, flags )

Signature:

<pre><code class="language-c">herr_t H5Pget_elink_acc_flags(
            hid_t lapl_id,
            unsigned *flags
        )

  </code></pre>

<pre><code class="language-fortran">NONE</code></pre>

Parameters:
hid_t lapl_idIN: Link access property list identifier
unsigned *flags

OUT: File access flag for link traversal

Valid values include:

H5F_ACC_RDWR - Files opened through external links will be opened with write access

H5F_ACC_RDONLY - Files opened through external links will be opened with read-only access

H5F_ACC_DEFAULT - Files opened through external links will be opened with the same access flag as the parent file

Description:

H5P_GET_ELINK_ACC_FLAGS retrieves the file access flag used to open an external link target file from the specified link access property list.

The value returned, if it is not H5F_ACC_DEFAULT will override the default access flag, which is the access flag used to open the parent file.

Returns:

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

Example Usage:

The following code retrieves the external link access flag settings on the link access property list lapl_id into a local variable:


unsigned acc_flags; status = H5Pget_elink_acc_flags(lapl_id, &acc_flags);

 

History:
Release    Change
1.8.3C function introduced in this release.