summaryrefslogtreecommitdiffstats
path: root/group___h5_d.html
diff options
context:
space:
mode:
authorlrknox <lrknox@users.noreply.github.com>2023-07-21 00:49:17 (GMT)
committerlrknox <lrknox@users.noreply.github.com>2023-07-21 00:49:17 (GMT)
commit175161c045ec8f1cc69b22030e416b60f40d5343 (patch)
tree9141df9563c2079e5b21245b7b5ca7e77a11066a /group___h5_d.html
parentc5642bdd325aaecbe7da51c4ecb02b2347867560 (diff)
downloadhdf5-175161c045ec8f1cc69b22030e416b60f40d5343.zip
hdf5-175161c045ec8f1cc69b22030e416b60f40d5343.tar.gz
hdf5-175161c045ec8f1cc69b22030e416b60f40d5343.tar.bz2
deploy: 1706355ee10cdad20b79603b3f39935601c5fff0
Diffstat (limited to 'group___h5_d.html')
-rw-r--r--group___h5_d.html62
1 files changed, 31 insertions, 31 deletions
diff --git a/group___h5_d.html b/group___h5_d.html
index bd6fd7e..9fa4a96 100644
--- a/group___h5_d.html
+++ b/group___h5_d.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.800edda</span>
+ &#160;<span id="projectnumber">1.15.0.1706355</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
@@ -376,7 +376,7 @@ Functions</h2></td></tr>
<tr class="memdesc:ga8d4a57e2b2b8c95cfecf6f75bdaa8343"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills dataspace elements with a fill value in a memory buffer. <a href="group___h5_d.html#ga8d4a57e2b2b8c95cfecf6f75bdaa8343">More...</a><br /></td></tr>
<tr class="separator:ga8d4a57e2b2b8c95cfecf6f75bdaa8343"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad31e1e0129f4520c531ce524de2a056f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f">H5Dset_extent</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dset_id, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> size[])</td></tr>
-<tr class="memdesc:gad31e1e0129f4520c531ce524de2a056f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Changes the sizes of a dataset’s dimensions. <a href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f">More...</a><br /></td></tr>
+<tr class="memdesc:gad31e1e0129f4520c531ce524de2a056f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Changes the sizes of a dataset's dimensions. <a href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f">More...</a><br /></td></tr>
<tr class="separator:gad31e1e0129f4520c531ce524de2a056f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a2175a62baa1e35ad2467bb1fdff1f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_d.html#ga4a2175a62baa1e35ad2467bb1fdff1f7">H5Dflush</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dset_id)</td></tr>
<tr class="memdesc:ga4a2175a62baa1e35ad2467bb1fdff1f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flushes all buffers associated with a dataset to disk. <a href="group___h5_d.html#ga4a2175a62baa1e35ad2467bb1fdff1f7">More...</a><br /></td></tr>
@@ -691,11 +691,11 @@ Functions</h2></td></tr>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>Superseded by <a class="el" href="group___h5_d.html#gabf62045119f4e9c512d87d77f2f992df" title="Creates a new dataset and links it into the file.">H5Dcreate2()</a> or the macro <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a>.</dd></dl>
<p><a class="el" href="group___h5_d.html#ga6b86f2683ae6a78d48d33c45257744a2" title="Creates a dataset at the specified location.">H5Dcreate1()</a> creates a data set with a name, <code>name</code>, in the location specified by the identifier <code>loc_id</code>. <code>loc_id</code> may be a file, group, dataset, named datatype or attribute. If an attribute, dataset, or named datatype is specified for <code>loc_id</code> then the dataset will be created at the location where the attribute, dataset, or named datatype is attached.</p>
<p><code>name</code> can be a relative path based at <code>loc_id</code> or an absolute path from the root of the file. Use of this function requires that any intermediate groups specified in the path already exist.</p>
-<p>The dataset’s datatype and dataspace are specified by <code>type_id</code> and <code>space_id</code>, respectively. These are the datatype and dataspace of the dataset as it will exist in the file, which may differ from the datatype and dataspace in application memory.</p>
+<p>The dataset's datatype and dataspace are specified by <code>type_id</code> and <code>space_id</code>, respectively. These are the datatype and dataspace of the dataset as it will exist in the file, which may differ from the datatype and dataspace in application memory.</p>
<p>Names within a group are unique: <a class="el" href="group___h5_d.html#ga6b86f2683ae6a78d48d33c45257744a2" title="Creates a dataset at the specified location.">H5Dcreate1()</a> will return an error if a link with the name specified in name already exists at the location specified in <code>loc_id</code>.</p>
<p>As is the case for any object in a group, the length of a dataset name is not limited.</p>
<p><code>dcpl_id</code> is an <a class="el" href="_h5_ppublic_8h.html#afcd7f8186c404f3a1d768632eacba102">H5P_DATASET_CREATE</a> property list created with <code>H5reate1()</code> and initialized with various property list functions described in Property List Interface.</p>
-<p><a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> and <a class="el" href="group___h5_d.html#ga15a77e82383d821fee8ecbf9ab8408cb" title="Creates a dataset in a file without linking it into the file structure.">H5Dcreate_anon()</a> return an error if the dataset’s datatype includes a variable-length (VL) datatype and the fill value is undefined, i.e., set to <code>NULL</code> in the dataset creation property list. Such a VL datatype may be directly included, indirectly included as part of a compound or array datatype, or indirectly included as part of a nested compound or array datatype.</p>
+<p><a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> and <a class="el" href="group___h5_d.html#ga15a77e82383d821fee8ecbf9ab8408cb" title="Creates a dataset in a file without linking it into the file structure.">H5Dcreate_anon()</a> return an error if the dataset's datatype includes a variable-length (VL) datatype and the fill value is undefined, i.e., set to <code>NULL</code> in the dataset creation property list. Such a VL datatype may be directly included, indirectly included as part of a compound or array datatype, or indirectly included as part of a nested compound or array datatype.</p>
<p><a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> and <a class="el" href="group___h5_d.html#ga15a77e82383d821fee8ecbf9ab8408cb" title="Creates a dataset in a file without linking it into the file structure.">H5Dcreate_anon()</a> return a dataset identifier for success or a negative value for failure. The dataset identifier should eventually be closed by calling <a class="el" href="group___h5_d.html#gae47c3f38db49db127faf221624c30609" title="Closes the specified dataset.">H5Dclose()</a> to release the resources it uses.</p>
<p>See <a class="el" href="group___h5_d.html#ga15a77e82383d821fee8ecbf9ab8408cb" title="Creates a dataset in a file without linking it into the file structure.">H5Dcreate_anon()</a> for a discussion of the differences between <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> and <a class="el" href="group___h5_d.html#ga15a77e82383d821fee8ecbf9ab8408cb" title="Creates a dataset in a file without linking it into the file structure.">H5Dcreate_anon()</a>.</p>
<p>The HDF5 library provides flexible means of specifying a fill value, of specifying when space will be allocated for a dataset, and of specifying when fill values will be written to a dataset.</p>
@@ -895,7 +895,7 @@ Functions</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>Returns a dataset identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="group___h5_d.html#ga15a77e82383d821fee8ecbf9ab8408cb" title="Creates a dataset in a file without linking it into the file structure.">H5Dcreate_anon()</a> creates a dataset in the file specified by <code>loc_id</code>.</p>
<p><code>loc_id</code> may specify a file, group, dataset, named datatype, or attribute. If an attribute, dataset, or named datatype is specified, then the dataset will be created at the location where the attribute, dataset, or named datatype is attached.</p>
-<p>The dataset’s datatype and dataspace are specified by <code>type_id</code> and <code>space_id</code>, respectively. These are the datatype and dataspace of the dataset as they will exist in the file, which may differ from the datatype and dataspace in application memory.</p>
+<p>The dataset's datatype and dataspace are specified by <code>type_id</code> and <code>space_id</code>, respectively. These are the datatype and dataspace of the dataset as they will exist in the file, which may differ from the datatype and dataspace in application memory.</p>
<p><a class="el" href="group___h5_d.html#ga15a77e82383d821fee8ecbf9ab8408cb" title="Creates a dataset in a file without linking it into the file structure.">H5Dcreate_anon()</a> returns a new dataset identifier. Using this identifier, the new dataset must be linked into the HDF5 file structure with <a class="el" href="group___h5_o.html#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a> or it will be deleted when the file is closed.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_o.html#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a>, <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> </dd></dl>
@@ -938,14 +938,14 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>Superseded by <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset’s dimensions.">H5Dset_extent()</a>.</dd></dl>
+<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>Superseded by <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset&#39;s dimensions.">H5Dset_extent()</a>.</dd></dl>
<p><a class="el" href="group___h5_d.html#gac4c0ff57977b1f39c1055296e39cbe91" title="Extends a dataset.">H5Dextend()</a> verifies that the dataset is at least of size <code>size</code>, extending it if necessary. The length of <code>size</code> is the same as that of the dataspace of the dataset being changed.</p>
<p>This function can be applied to the following datasets: </p><ul>
<li>Any dataset with unlimited dimensions </li>
<li>A dataset with fixed dimensions if the current dimension sizes are less than the maximum sizes set with <code>maxdims</code> (see <a class="el" href="group___h5_s.html#ga8e35eea5738b4805856eac7d595254ae" title="Creates a new simple dataspace and opens it for access.">H5Screate_simple()</a>)</li>
</ul>
-<p>Space on disk is immediately allocated for the new dataset extent if the dataset’s space allocation time is set to <a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a3c461ed83e0af151ef8c44ec232368b6">H5D_ALLOC_TIME_EARLY</a>. Fill values will be written to the dataset if the dataset’s fill time is set to <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aa85b225308b0a277c4dd6fed7ee465a72">H5D_FILL_TIME_IFSET</a> or <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aadd7bb84666434f7d1dc642e94c68eb28">H5D_FILL_TIME_ALLOC</a>. (See <a class="el" href="group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a> and <a class="el" href="group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a>.)</p>
-<p>This function ensures that the dataset dimensions are of at least the sizes specified in size. The function <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset’s dimensions.">H5Dset_extent()</a> must be used if the dataset dimension sizes are to be reduced.</p>
+<p>Space on disk is immediately allocated for the new dataset extent if the dataset's space allocation time is set to <a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a3c461ed83e0af151ef8c44ec232368b6">H5D_ALLOC_TIME_EARLY</a>. Fill values will be written to the dataset if the dataset's fill time is set to <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aa85b225308b0a277c4dd6fed7ee465a72">H5D_FILL_TIME_IFSET</a> or <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aadd7bb84666434f7d1dc642e94c68eb28">H5D_FILL_TIME_ALLOC</a>. (See <a class="el" href="group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a> and <a class="el" href="group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a>.)</p>
+<p>This function ensures that the dataset dimensions are of at least the sizes specified in size. The function <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset&#39;s dimensions.">H5Dset_extent()</a> must be used if the dataset dimension sizes are to be reduced.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. Parameter size syntax changed to <code>const hsize_t size[]</code> in this release. </dd></dl>
</div>
@@ -1156,7 +1156,7 @@ Applications sometimes write data only to portions of an allocated dataset. It i
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a dataset access property list identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="group___h5_d.html#ga252c0ddac7a7817bd757190e7398353b" title="Returns the dataset access property list associated with a dataset.">H5Dget_access_plist()</a> returns a copy of the dataset access property list used to open the specified dataset, <code>dset_id</code>. Modifications to the returned property list will have no effect on the dataset it was retrieved from.</p>
-<p>The chunk cache parameters in the returned property lists will be those used by the dataset. If the properties in the file access property list were used to determine the dataset's chunk cache configuration, then those properties will be present in the returned dataset access property list. If the dataset does not use a chunked layout, then the chunk cache properties will be set to the default. The chunk cache properties in the returned list are considered to be “set”, and any use of this list will override the corresponding properties in the file’s file access property list.</p>
+<p>The chunk cache parameters in the returned property lists will be those used by the dataset. If the properties in the file access property list were used to determine the dataset's chunk cache configuration, then those properties will be present in the returned dataset access property list. If the dataset does not use a chunked layout, then the chunk cache properties will be set to the default. The chunk cache properties in the returned list are considered to be “set”, and any use of this list will override the corresponding properties in the file's file access property list.</p>
<p>All link access properties in the returned list will be set to the default values.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.3 </dd></dl>
@@ -1225,7 +1225,7 @@ Applications sometimes write data only to portions of an allocated dataset. It i
<tr><td class="paramdir">[in]</td><td class="paramname">dset_id</td><td>Dataset identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fspace_id</td><td>File dataspace selection identifier (See Note below) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">chk_idx</td><td>Index of the chunk </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">offset</td><td>Logical position of the chunk’s first element in units of dataset elements </td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">offset</td><td>Logical position of the chunk's first element in units of dataset elements </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">filter_mask</td><td>Bitmask indicating the filters used when the chunk was written </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">addr</td><td>Chunk address in the file </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Chunk size in bytes, 0 if the chunk does not exist</td></tr>
@@ -1291,7 +1291,7 @@ Applications sometimes write data only to portions of an allocated dataset. It i
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dset_id</td><td>Dataset identifier </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Logical position of the chunk’s first element in units of dataset elements </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Logical position of the chunk's first element in units of dataset elements </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">filter_mask</td><td>Bitmask indicating the filters used when the chunk was written </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">addr</td><td>Chunk address in the file </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Chunk size in bytes, 0 if the chunk does not exist</td></tr>
@@ -1301,7 +1301,7 @@ Applications sometimes write data only to portions of an allocated dataset. It i
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_d.html#ga408a49c6ec59c5b65ce4c791f8d26cb0" title="Retrieves information about a chunk specified by its coordinates.">H5Dget_chunk_info_by_coord()</a> retrieves the <code>filter_mask</code>, <code>size</code>, and <code>addr</code> for a chunk in the dataset specified by <code>dset_id</code>, using the coordinates specified by <code>offset</code>.</p>
<p>If the queried chunk does not exist in the file, <code>size</code> will be set to 0, <code>addr</code> to <code>HADDR_UNDEF</code>, and the buffer <code>filter_mask</code> will not be modified.</p>
-<p><code>offset</code> is a pointer to a one-dimensional array with a size equal to the dataset’s rank. Each element is the logical position of the chunk’s first element in a dimension.</p>
+<p><code>offset</code> is a pointer to a one-dimensional array with a size equal to the dataset's rank. Each element is the logical position of the chunk's first element in a dimension.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.5 </dd></dl>
</div>
@@ -1969,16 +1969,16 @@ Applications sometimes write data only to portions of an allocated dataset. It i
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dset_id</td><td>Dataset identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Logical position of the chunk’s first element in the dataspace </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Logical position of the chunk's first element in the dataspace </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">filters</td><td>Mask for identifying the filters in use </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer containing data to be written to the chunk</td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer containing data to be read from the chunk</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
-<p><a class="el" href="group___h5_d.html#gac1092a63b718ec949d6539590a914b60" title="Reads a raw data chunk directly from a dataset in a file into a buffer.">H5Dread_chunk()</a> reads a raw data chunk as specified by its logical offset <code>offset</code> in a chunked dataset <code>dset_id</code> from the dataset in the file into the application memory buffer <code>buf</code>. The data in <code>buf</code> is read directly from the file bypassing the library’s internal data transfer pipeline, including filters.</p>
-<p><code>offset</code> is an array specifying the logical position of the first element of the chunk in the dataset’s dataspace. The length of the <code>offset</code> array must equal the number of dimensions, or rank, of the dataspace. The values in <code>offset</code> must not exceed the dimension limits and must specify a point that falls on a dataset chunk boundary.</p>
-<p>The mask <code>filters</code> indicates which filters were used when the chunk was written. A zero value (all bits 0) indicates that all enabled filters are applied on the chunk. A filter is skipped if the bit corresponding to the filter’s position in the pipeline (0 ≤ position &lt; 32) is turned on.</p>
+<p><a class="el" href="group___h5_d.html#gac1092a63b718ec949d6539590a914b60" title="Reads a raw data chunk directly from a dataset in a file into a buffer.">H5Dread_chunk()</a> reads a raw data chunk as specified by its logical offset <code>offset</code> in a chunked dataset <code>dset_id</code> from the dataset in the file into the application memory buffer <code>buf</code>. The data in <code>buf</code> is read directly from the file bypassing the library's internal data transfer pipeline, including filters.</p>
+<p><code>offset</code> is an array specifying the logical position of the first element of the chunk in the dataset's dataspace. The length of the <code>offset</code> array must equal the number of dimensions, or rank, of the dataspace. The values in <code>offset</code> must not exceed the dimension limits and must specify a point that falls on a dataset chunk boundary.</p>
+<p>The mask <code>filters</code> indicates which filters were used when the chunk was written. A zero value (all bits 0) indicates that all enabled filters are applied on the chunk. A filter is skipped if the bit corresponding to the filter's position in the pipeline (0 ≤ position &lt; 32) is turned on.</p>
<p><code>buf</code> is the memory buffer containing the chunk read from the dataset in the file.</p>
<dl class="section attention"><dt>Attention</dt><dd>Exercise caution when using <a class="el" href="group___h5_d.html#gac1092a63b718ec949d6539590a914b60" title="Reads a raw data chunk directly from a dataset in a file into a buffer.">H5Dread_chunk()</a> and <a class="el" href="group___h5_d.html#ga416ccd200929b11386a10e9024977109" title="Writes a raw data chunk from a buffer directly to a dataset in a file.">H5Dwrite_chunk()</a>, as they read and write data chunks directly in a file. <a class="el" href="group___h5_d.html#ga416ccd200929b11386a10e9024977109" title="Writes a raw data chunk from a buffer directly to a dataset in a file.">H5Dwrite_chunk()</a> bypasses hyperslab selection, the conversion of data from one datatype to another, and the filter pipeline to write the chunk. Developers should have experience with these processes before using this function. Please see Using the Direct Chunk Write Function for more information.</dd></dl>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="group___h5_d.html#gac1092a63b718ec949d6539590a914b60" title="Reads a raw data chunk directly from a dataset in a file into a buffer.">H5Dread_chunk()</a> and <a class="el" href="group___h5_d.html#ga416ccd200929b11386a10e9024977109" title="Writes a raw data chunk from a buffer directly to a dataset in a file.">H5Dwrite_chunk()</a> are currently not supported with parallel HDF5 and do not support variable-length datatypes.</dd></dl>
@@ -2188,7 +2188,7 @@ Applications sometimes write data only to portions of an allocated dataset. It i
</table>
</div><div class="memdoc">
-<p>Changes the sizes of a dataset’s dimensions. </p>
+<p>Changes the sizes of a dataset's dimensions. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
@@ -2198,8 +2198,8 @@ Applications sometimes write data only to portions of an allocated dataset. It i
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
-<p><a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset’s dimensions.">H5Dset_extent()</a> sets the current dimensions of the chunked dataset <code>dset_id</code> to the sizes specified in size.</p>
-<p><code>size</code> is a 1-dimensional array with n elements, where <code>n</code> is the rank of the dataset’s current dataspace.</p>
+<p><a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset&#39;s dimensions.">H5Dset_extent()</a> sets the current dimensions of the chunked dataset <code>dset_id</code> to the sizes specified in size.</p>
+<p><code>size</code> is a 1-dimensional array with n elements, where <code>n</code> is the rank of the dataset's current dataspace.</p>
<p>This function can be applied to the following datasets:</p><ul>
<li>A chunked dataset with unlimited dimensions</li>
<li>A chunked dataset with fixed dimensions if the new dimension sizes are less than the maximum sizes set with maxdims (see <a class="el" href="group___h5_s.html#ga8e35eea5738b4805856eac7d595254ae" title="Creates a new simple dataspace and opens it for access.">H5Screate_simple()</a>)</li>
@@ -2207,17 +2207,17 @@ Applications sometimes write data only to portions of an allocated dataset. It i
<li>An external dataset with fixed dimensions if the new dimension sizes are less than the maximum sizes set with <code>maxdims</code> </li>
</ul>
<p>Note that external datasets are always contiguous and can be extended only along the first dimension.</p>
-<p>Space on disk is immediately allocated for the new dataset extent if the dataset’s space allocation time is set to <a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a3c461ed83e0af151ef8c44ec232368b6">H5D_ALLOC_TIME_EARLY</a>.</p>
+<p>Space on disk is immediately allocated for the new dataset extent if the dataset's space allocation time is set to <a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a3c461ed83e0af151ef8c44ec232368b6">H5D_ALLOC_TIME_EARLY</a>.</p>
<p>Fill values will be written to the dataset in either of the following situations, but not otherwise:</p>
<ul>
-<li>If the dataset’s fill time is set to <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aa85b225308b0a277c4dd6fed7ee465a72">H5D_FILL_TIME_IFSET</a> and a fill value is defined (see <a class="el" href="group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a> and <a class="el" href="group___d_c_p_l.html#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value()</a>)</li>
-<li>If the dataset’s fill time is set to <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aadd7bb84666434f7d1dc642e94c68eb28">H5D_FILL_TIME_ALLOC</a> (see <a class="el" href="group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a>)</li>
+<li>If the dataset's fill time is set to <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aa85b225308b0a277c4dd6fed7ee465a72">H5D_FILL_TIME_IFSET</a> and a fill value is defined (see <a class="el" href="group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a> and <a class="el" href="group___d_c_p_l.html#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value()</a>)</li>
+<li>If the dataset's fill time is set to <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aadd7bb84666434f7d1dc642e94c68eb28">H5D_FILL_TIME_ALLOC</a> (see <a class="el" href="group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a>)</li>
</ul>
-<dl class="section note"><dt>Note</dt><dd>If the sizes specified in <code>size</code> array are smaller than the dataset’s current dimension sizes, <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset’s dimensions.">H5Dset_extent()</a> will reduce the dataset’s dimension sizes to the specified values. It is the user application’s responsibility to ensure that valuable data is not lost as <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset’s dimensions.">H5Dset_extent()</a> does not check.</dd>
+<dl class="section note"><dt>Note</dt><dd>If the sizes specified in <code>size</code> array are smaller than the dataset's current dimension sizes, <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset&#39;s dimensions.">H5Dset_extent()</a> will reduce the dataset's dimension sizes to the specified values. It is the user application's responsibility to ensure that valuable data is not lost as <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset&#39;s dimensions.">H5Dset_extent()</a> does not check.</dd>
<dd>
-Except for external datasets, <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset’s dimensions.">H5Dset_extent()</a> is for use with chunked datasets only, not contiguous datasets.</dd>
+Except for external datasets, <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset&#39;s dimensions.">H5Dset_extent()</a> is for use with chunked datasets only, not contiguous datasets.</dd>
<dd>
-A call to <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset’s dimensions.">H5Dset_extent()</a> affects the dataspace of a dataset. If a dataspace handle was opened for a dataset prior to a call to <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset’s dimensions.">H5Dset_extent()</a> then that dataspace handle will no longer reflect the correct dataspace extent of the dataset. <a class="el" href="group___h5_d.html#gad42a46be153d895d8c28a11ebf5a0d0a" title="Returns an identifier for a copy of the dataspace for a dataset.">H5Dget_space()</a> must be called (after closing the previous handle) to obtain the current dataspace extent.</dd></dl>
+A call to <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset&#39;s dimensions.">H5Dset_extent()</a> affects the dataspace of a dataset. If a dataspace handle was opened for a dataset prior to a call to <a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset&#39;s dimensions.">H5Dset_extent()</a> then that dataspace handle will no longer reflect the correct dataspace extent of the dataset. <a class="el" href="group___h5_d.html#gad42a46be153d895d8c28a11ebf5a0d0a" title="Returns an identifier for a copy of the dataspace for a dataset.">H5Dget_space()</a> must be called (after closing the previous handle) to obtain the current dataspace extent.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
@@ -2528,16 +2528,16 @@ If a dataset's storage layout is 'compact', care must be taken when writing data
<tr><td class="paramdir">[in]</td><td class="paramname">dset_id</td><td>Dataset identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filters</td><td>Mask for identifying the filters in use </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Logical position of the chunk’s first element in the dataspace </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Logical position of the chunk's first element in the dataspace </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data_size</td><td>Size of the actual data to be written in bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer containing data to be written to the chunk</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
-<p><a class="el" href="group___h5_d.html#ga416ccd200929b11386a10e9024977109" title="Writes a raw data chunk from a buffer directly to a dataset in a file.">H5Dwrite_chunk()</a> writes a raw data chunk as specified by its logical offset <code>offset</code> in a chunked dataset <code>dset_id</code> from the application memory buffer <code>buf</code> to the dataset in the file. Typically, the data in <code>buf</code> is preprocessed in memory by a custom transformation, such as compression. The chunk will bypass the library’s internal data transfer pipeline, including filters, and will be written directly to the file. Only one chunk can be written with this function.</p>
-<p><code>filters</code> is a mask providing a record of which filters are used with the chunk. The default value of the mask is zero (0), indicating that all enabled filters are applied. A filter is skipped if the bit corresponding to the filter’s position in the pipeline (0 ≤ position &lt; 32) is turned on. This mask is saved with the chunk in the file.</p>
-<p><code>offset</code> is an array specifying the logical position of the first element of the chunk in the dataset’s dataspace. The length of the offset array must equal the number of dimensions, or rank, of the dataspace. The values in offset must not exceed the dimension limits and must specify a point that falls on a dataset chunk boundary.</p>
+<p><a class="el" href="group___h5_d.html#ga416ccd200929b11386a10e9024977109" title="Writes a raw data chunk from a buffer directly to a dataset in a file.">H5Dwrite_chunk()</a> writes a raw data chunk as specified by its logical offset <code>offset</code> in a chunked dataset <code>dset_id</code> from the application memory buffer <code>buf</code> to the dataset in the file. Typically, the data in <code>buf</code> is preprocessed in memory by a custom transformation, such as compression. The chunk will bypass the library's internal data transfer pipeline, including filters, and will be written directly to the file. Only one chunk can be written with this function.</p>
+<p><code>filters</code> is a mask providing a record of which filters are used with the chunk. The default value of the mask is zero (0), indicating that all enabled filters are applied. A filter is skipped if the bit corresponding to the filter's position in the pipeline (0 ≤ position &lt; 32) is turned on. This mask is saved with the chunk in the file.</p>
+<p><code>offset</code> is an array specifying the logical position of the first element of the chunk in the dataset's dataspace. The length of the offset array must equal the number of dimensions, or rank, of the dataspace. The values in offset must not exceed the dimension limits and must specify a point that falls on a dataset chunk boundary.</p>
<p><code>data_size</code> is the size in bytes of the chunk, representing the number of bytes to be read from the buffer <code>buf</code>. If the data chunk has been precompressed, <code>data_size</code> should be the size of the compressed data.</p>
<p><code>buf</code> is the memory buffer containing data to be written to the chunk in the file.</p>
<dl class="section attention"><dt>Attention</dt><dd>Exercise caution when using <a class="el" href="group___h5_d.html#gac1092a63b718ec949d6539590a914b60" title="Reads a raw data chunk directly from a dataset in a file into a buffer.">H5Dread_chunk()</a> and <a class="el" href="group___h5_d.html#ga416ccd200929b11386a10e9024977109" title="Writes a raw data chunk from a buffer directly to a dataset in a file.">H5Dwrite_chunk()</a>, as they read and write data chunks directly in a file. <a class="el" href="group___h5_d.html#ga416ccd200929b11386a10e9024977109" title="Writes a raw data chunk from a buffer directly to a dataset in a file.">H5Dwrite_chunk()</a> bypasses hyperslab selection, the conversion of data from one datatype to another, and the filter pipeline to write the chunk. Developers should have experience with these processes before using this function.</dd></dl>
@@ -2630,7 +2630,7 @@ If a dataset's storage layout is 'compact', care must be taken when writing data
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
- <li class="footer">Generated on Wed Jul 19 2023 00:58:01 for HDF5 by
+ <li class="footer">Generated on Fri Jul 21 2023 00:33:45 for HDF5 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li>
</ul>