Gets the information of the given Read-Only S3 virtual file driver

Procedure:

H5P_GET_FAPL_ROS3 (fapl_id, fa)

Signature:

<pre><code class="language-c">herr_t H5Pget_fapl_ros3(hid_t fapl_id, H5FD_ros3_fapl_t *fa)
  </code></pre>

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

Parameters:
hid_t fapl_idIN: File access property list identifier
H5FD_ros3_fapl_t *faOUT: H5FD_ros3_fapl_t structure destination

Description:

H5P_GET_FAPL_ROS3 copies information from the fapl fapl_id to the H5FD_ros3_fapl_t structure pointed to by fa.

Returns:

Non-negative value if successful. Otherwise returns negative value.

Example:
    H5FD_ros3_fapl_t fa;
    fa.authenticate = 16; /* neither TRUE (0) nor FALSE (-1) *
    assert( 0 >= H5Pget_fapl_ros3(fapl_id, &fa) );
    assert( fa.authenticate == 0 || fa.authenticate == -1 );

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