summaryrefslogtreecommitdiffstats
path: root/_h5_f__u_g.html
diff options
context:
space:
mode:
authorbyrnHDF <byrnHDF@users.noreply.github.com>2023-10-19 14:56:41 (GMT)
committerbyrnHDF <byrnHDF@users.noreply.github.com>2023-10-19 14:56:41 (GMT)
commit7db2295e2c49bddd1285d138ad614e678d77ea8b (patch)
tree1d32f633610f9e2dac6b2bda958b1db35f8331ad /_h5_f__u_g.html
parent4e486895d05e6d1665f0d90eb113207634260a54 (diff)
downloadhdf5-7db2295e2c49bddd1285d138ad614e678d77ea8b.zip
hdf5-7db2295e2c49bddd1285d138ad614e678d77ea8b.tar.gz
hdf5-7db2295e2c49bddd1285d138ad614e678d77ea8b.tar.bz2
deploy: c4a146efc40c66de7d06a387465c9f7ea9b2e280
Diffstat (limited to '_h5_f__u_g.html')
-rw-r--r--_h5_f__u_g.html14
1 files changed, 7 insertions, 7 deletions
diff --git a/_h5_f__u_g.html b/_h5_f__u_g.html
index 08c0fc7..3530759 100644
--- a/_h5_f__u_g.html
+++ b/_h5_f__u_g.html
@@ -37,7 +37,7 @@
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
- &#160;<span id="projectnumber">1.15.0.b166368</span>
+ &#160;<span id="projectnumber">1.15.0.c4a146e</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
@@ -463,7 +463,7 @@ File Function Summaries</h2>
<tr>
<td><a class="el" href="group___f_a_p_l.html#gaad28d8c24f236590193215c5ae7a8f18" title="Modifies the specified File Access Property List to use the H5FD_ROS3 driver.">H5Pset_fapl_ros3</a>/<a class="el" href="group___f_a_p_l.html#ga13e273711e160cbd58e60c701b4f50e6" title="Queries a File Access Property List for H5FD_ROS3 file driver properties.">H5Pget_fapl_ros3</a> </td><td>Modifies/queries the file driver properties of the ros3 driver. </td></tr>
<tr>
-<td><a class="el" href="_h5_f_dsec2_8h.html#af581bceca36ad4eef3cd45b16eabbb20">H5Pset_fapl_sec2</a> </td><td>Sets driver for unbuffered permanent files or retrieves information regarding driver. </td></tr>
+<td><a class="el" href="group___f_a_p_l.html#gaf581bceca36ad4eef3cd45b16eabbb20" title="Modifies the file access property list to use the H5FD_SEC2 driver.">H5Pset_fapl_sec2</a> </td><td>Sets driver for unbuffered permanent files or retrieves information regarding driver. </td></tr>
<tr>
<td><a class="el" href="group___f_a_p_l.html#ga502f1ad38f5143cf281df8282fef26ed" title="Emulates the old split file driver.">H5Pset_fapl_split</a> </td><td>Sets driver for split files, a limited case of multi driver with one metadata file and one raw data file. </td></tr>
<tr>
@@ -595,7 +595,7 @@ I/O path from application to VFL and low-level drivers to storage</div></div>
<tr>
<th>Driver Name </th><th>Driver Identifier </th><th>Description </th><th>Related API </th></tr>
<tr>
-<td>POSIX </td><td><a class="el" href="_h5_f_dsec2_8h.html#a15ae1f958e1cf11cb239916d76b10606">H5FD_SEC2</a> </td><td>This driver uses POSIX file-system functions like read and write to perform I/O to a single, permanent file on local disk with no system buffering. This driver is POSIX-compliant and is the default file driver for all systems. </td><td><a class="el" href="_h5_f_dsec2_8h.html#af581bceca36ad4eef3cd45b16eabbb20">H5Pset_fapl_sec2</a> </td></tr>
+<td>POSIX </td><td><a class="el" href="_h5_f_dsec2_8h.html#a15ae1f958e1cf11cb239916d76b10606">H5FD_SEC2</a> </td><td>This driver uses POSIX file-system functions like read and write to perform I/O to a single, permanent file on local disk with no system buffering. This driver is POSIX-compliant and is the default file driver for all systems. </td><td><a class="el" href="group___f_a_p_l.html#gaf581bceca36ad4eef3cd45b16eabbb20" title="Modifies the file access property list to use the H5FD_SEC2 driver.">H5Pset_fapl_sec2</a> </td></tr>
<tr>
<td>Memory </td><td><a class="el" href="_h5_f_dcore_8h.html#ae449696f6b86abcd1120beab21fff76a">H5FD_CORE</a> </td><td>With this driver, an application can work with a file in memory for faster reads and writes. File contents are kept in memory until the file is closed. At closing, the memory version of the file can be written back to disk or abandoned. </td><td><a class="el" href="group___f_a_p_l.html#ga6e6628f620a1c58c704129cf07282849" title="Modifies the file access property list to use the H5FD_CORE driver.">H5Pset_fapl_core</a> </td></tr>
<tr>
@@ -645,9 +645,9 @@ Identifying the Previously‐used File Driver</h3>
<h3><a class="anchor" id="subsubsec_file_alternate_drivers_sec2"></a>
The POSIX (aka SEC2) Driver</h3>
<p>The POSIX driver, <a class="el" href="_h5_f_dsec2_8h.html#a15ae1f958e1cf11cb239916d76b10606">H5FD_SEC2</a>, uses functions from section 2 of the POSIX manual to access unbuffered files stored on a local file system. This driver is also known as the SEC2 driver. The HDF5 Library buffers metadata regardless of the low-level driver, but using this driver prevents data from being buffered again by the lowest layers of the library.</p>
-<p>The function <a class="el" href="_h5_f_dsec2_8h.html#af581bceca36ad4eef3cd45b16eabbb20">H5Pset_fapl_sec2</a> sets the file access properties to use the POSIX driver. See the example below.</p>
-<p><em>Using the POSIX, aka SEC2, driver</em> </p><div class="fragment"><div class="line"><a class="code" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code" href="_h5_f_dsec2_8h.html#af581bceca36ad4eef3cd45b16eabbb20">H5Pset_fapl_sec2</a> (<a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id)</div>
-<div class="ttc" id="a_h5_f_dsec2_8h_html_af581bceca36ad4eef3cd45b16eabbb20"><div class="ttname"><a href="_h5_f_dsec2_8h.html#af581bceca36ad4eef3cd45b16eabbb20">H5Pset_fapl_sec2</a></div><div class="ttdeci">H5_DLL herr_t H5Pset_fapl_sec2(hid_t fapl_id)</div></div>
+<p>The function <a class="el" href="group___f_a_p_l.html#gaf581bceca36ad4eef3cd45b16eabbb20" title="Modifies the file access property list to use the H5FD_SEC2 driver.">H5Pset_fapl_sec2</a> sets the file access properties to use the POSIX driver. See the example below.</p>
+<p><em>Using the POSIX, aka SEC2, driver</em> </p><div class="fragment"><div class="line"><a class="code" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code" href="group___f_a_p_l.html#gaf581bceca36ad4eef3cd45b16eabbb20">H5Pset_fapl_sec2</a> (<a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id)</div>
+<div class="ttc" id="agroup___f_a_p_l_html_gaf581bceca36ad4eef3cd45b16eabbb20"><div class="ttname"><a href="group___f_a_p_l.html#gaf581bceca36ad4eef3cd45b16eabbb20">H5Pset_fapl_sec2</a></div><div class="ttdeci">H5_DLL herr_t H5Pset_fapl_sec2(hid_t fapl_id)</div><div class="ttdoc">Modifies the file access property list to use the H5FD_SEC2 driver.</div></div>
</div><!-- fragment --><p>Any previously-defined driver properties are erased from the property list.</p>
<p>Additional parameters may be added to this function in the future. Since there are no additional variable settings associated with the POSIX driver, there is no H5Pget_fapl_sec2 function.</p>
<h3><a class="anchor" id="subsubsec_file_alternate_drivers_direct"></a>
@@ -793,7 +793,7 @@ The Parallel Driver</h3>
<div class="line"><a class="code" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code" href="group___f_a_p_l.html#ga5d9e4b9f27791ccf19484a898f3fd6fa">H5Pget_fapl_mpio</a> (<a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, MPI_Comm *comm, MPI_info *info)</div>
<div class="ttc" id="agroup___f_a_p_l_html_ga5d9e4b9f27791ccf19484a898f3fd6fa"><div class="ttname"><a href="group___f_a_p_l.html#ga5d9e4b9f27791ccf19484a898f3fd6fa">H5Pget_fapl_mpio</a></div><div class="ttdeci">H5_DLL herr_t H5Pget_fapl_mpio(hid_t fapl_id, MPI_Comm *comm, MPI_Info *info)</div><div class="ttdoc">Returns MPI IO communicator information.</div></div>
<div class="ttc" id="agroup___f_a_p_l_html_gaa0204810c1fea1667d62cf7c176416ff"><div class="ttname"><a href="group___f_a_p_l.html#gaa0204810c1fea1667d62cf7c176416ff">H5Pset_fapl_mpio</a></div><div class="ttdeci">H5_DLL herr_t H5Pset_fapl_mpio(hid_t fapl_id, MPI_Comm comm, MPI_Info info)</div><div class="ttdoc">Stores MPI IO communicator information to the file access property list.</div></div>
-</div><!-- fragment --><p>The file access properties managed by <a class="el" href="group___f_a_p_l.html#gaa0204810c1fea1667d62cf7c176416ff" title="Stores MPI IO communicator information to the file access property list.">H5Pset_fapl_mpio</a> and retrieved by <a class="el" href="group___f_a_p_l.html#ga5d9e4b9f27791ccf19484a898f3fd6fa" title="Returns MPI IO communicator information.">H5Pget_fapl_mpio</a> are the MPI communicator, comm, and the MPI info object, info. comm and info are used for file open. info is an information object much like an HDF5 property list. Both are defined in MPI_FILE_OPEN of MPI-2.</p>
+</div><!-- fragment --><p>The file access properties managed by <a class="el" href="group___f_a_p_l.html#gaa0204810c1fea1667d62cf7c176416ff" title="Stores MPI IO communicator information to the file access property list.">H5Pset_fapl_mpio</a> and retrieved by <a class="el" href="group___f_a_p_l.html#ga5d9e4b9f27791ccf19484a898f3fd6fa" title="Returns MPI IO communicator information.">H5Pget_fapl_mpio</a> are the MPI communicator, comm, and the MPI info object, info. comm and info are used for file open. info is an information object much like an HDF5 property list. Both are defined in MPI_FILE_OPEN of MPI.</p>
<p>The communicator and the info object are saved in the file access property list fapl_id. fapl_id can then be passed to MPI_FILE_OPEN to create and/or open the file.</p>
<p><a class="el" href="group___f_a_p_l.html#gaa0204810c1fea1667d62cf7c176416ff" title="Stores MPI IO communicator information to the file access property list.">H5Pset_fapl_mpio</a> and <a class="el" href="group___f_a_p_l.html#ga5d9e4b9f27791ccf19484a898f3fd6fa" title="Returns MPI IO communicator information.">H5Pget_fapl_mpio</a> are available only in the parallel HDF5 Library and are not collective functions. The Parallel driver is available only in the parallel HDF5 Library.</p>
<p>Additional parameters may be added to these functions in the future.</p>