summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/html/RM_H5D.html55
1 files changed, 40 insertions, 15 deletions
diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html
index c45e353..7b4356d 100644
--- a/doc/html/RM_H5D.html
+++ b/doc/html/RM_H5D.html
@@ -345,7 +345,7 @@ facilitate moving easily between them.</i>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-GetSpaceStatus">H5Dget_space_status</a>
<dt><strong>Signature:</strong>
- <dd><em>hid_t</em> <code>H5Dget_space_status</code>(<em>hid_t </em><code>dset_id</code>,
+ <dd><em>herr_t</em> <code>H5Dget_space_status</code>(<em>hid_t </em><code>dset_id</code>,
<em>H5D_space_status_t *</em><code>status</code>)
<dt><strong>Purpose:</strong>
<dd>Determines whether space has been allocated for a dataset.
@@ -378,7 +378,7 @@ facilitate moving easily between them.</i>
<dt><em>hid_t</em> <code>dset_id</code>
<dd>IN: Identifier of the dataset to query.
<dt><em>H5D_space_status_t *</em><code>status</code>
- <dd>OUT: Space allocatioin status.
+ <dd>OUT: Space allocation status.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
@@ -704,7 +704,7 @@ facilitate moving easily between them.</i>
<tr valign="top">
<td>
- H5S_ALL
+ <code>H5S_ALL</code>
</td>
<td>
valid dataspace identifier
@@ -713,8 +713,8 @@ facilitate moving easily between them.</i>
The file dataset's dataspace is used for the memory dataspace and the
selection specified with <code>file_space_id</code> specifies the
selection within it.
- <code>file_space_id</code> specifies the selection within the file
- dataset's dataspace.
+ The combination of the file dataset's dataspace and the selection from
+ <code>file_space_id</code> is used for memory also.
</td>
</tr>
@@ -723,7 +723,7 @@ facilitate moving easily between them.</i>
valid dataspace identifier
</td>
<td>
- H5S_ALL
+ <code>H5S_ALL</code>
</td>
<td>
<code>mem_space_id</code> specifies the memory dataspace and the
@@ -735,10 +735,10 @@ facilitate moving easily between them.</i>
<tr valign="top">
<td>
- H5S_ALL
+ <code>H5S_ALL</code>
</td>
<td>
- H5S_ALL
+ <code>H5S_ALL</code>
</td>
<td>
The file dataset's dataspace is used for the memory dataspace and the
@@ -751,7 +751,7 @@ facilitate moving easily between them.</i>
</table>
<p>
- Setting an "all" selection indicates that the entire dataspace, as
+ Setting an <code>H5S_ALL</code> selection indicates that the entire dataspace, as
defined by the current dimensions of a dataspace, will be selected.
The number of elements selected in the memory dataspace must match the
number of elements selected in the file dataspace.
@@ -761,7 +761,7 @@ facilitate moving easily between them.</i>
<p>
Data is automatically converted from the file datatype
and dataspace to the memory datatype and dataspace
- at the time of the write. See the
+ at the time of the read. See the
<a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a>
section of <cite>The Data Type Interface (H5T)</cite> in the
<cite>HDF5 User's Guide</cite> for a discussion of
@@ -879,8 +879,8 @@ facilitate moving easily between them.</i>
The file dataset's dataspace is used for the memory dataspace and the
selection specified with <code>file_space_id</code> specifies the
selection within it.
- <code>file_space_id</code> specifies the selection within the file
- dataset's dataspace.
+ The combination of the file dataset's dataspace and the selection from
+ <code>file_space_id</code> is used for memory also.
</td>
</tr>
@@ -913,7 +913,6 @@ facilitate moving easily between them.</i>
selection.
</td>
</tr>
-
</table>
<p>
@@ -936,6 +935,20 @@ facilitate moving easily between them.</i>
<cite>HDF5 User's Guide</cite> for a discussion of
data conversion, including the range of conversions currently
supported by the HDF5 libraries.
+ <p>
+ If the dataset's space allocation time is set to
+ <code>H5D_ALLOC_TIME_LATE</code> or <code>H5D_ALLOC_TIME_INCR</code>
+ and the space for the dataset has not yet been allocated,
+ that space is allocated when the first raw data is written to the
+ dataset.
+ Unused space in the dataset will be written with fill values at the
+ same time if the dataset's fill time is set to
+ <code>H5D_FILL_TIME_IFSET</code> or <code>H5D_FILL_TIME_ALLOC</code>.
+ (Also see
+ <a href="RM_H5P.html#Property-SetFillTime">H5Pset_fill_time</a>
+ and
+ <a href="RM_H5P.html#Property-SetAllocTime">H5Pset_alloc_time</a>.)
+
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dataset_id</code>
@@ -979,6 +992,18 @@ facilitate moving easily between them.</i>
The dimensionality of <code>size</code> is the same as that of
the dataspace of the dataset being changed.
This function cannot be applied to a dataset with fixed dimensions.
+ <p>
+ Space on disk is immediately allocated for the new dataset extent
+ if the dataset's space allocation time is set to
+ <code>H5D_ALLOC_TIME_EARLY</code>.
+ Fill values will be written to the dataset if the dataset's fill time
+ is set to <code>H5D_FILL_TIME_IFSET</code> or
+ <code>H5D_FILL_TIME_ALLOC</code>.
+ (Also see
+ <a href="RM_H5P.html#Property-SetFillTime">H5Pset_fill_time</a>
+ and
+ <a href="RM_H5P.html#Property-SetAllocTime">H5Pset_alloc_time</a>.)
+
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dataset_id</code>
@@ -1120,7 +1145,7 @@ facilitate moving easily between them.</i>
before filling the selection.
<dt><strong>Note:</strong>
<dd>Applications sometimes write data only to portions of
- an allcoated dataset. It is often useful in such cases
+ an allocated dataset. It is often useful in such cases
to fill the unused space with a known
<span class="termEmphasis">fill value</span>.
See <a href="RM_H5P.html#Property-SetFillValue">H5Pset_fill_value</a>
@@ -1200,7 +1225,7 @@ And in this document, the
Describes HDF5 Release 1.5, Unreleased Development Branch
</address><!-- #EndLibraryItem -->
-Last modified: 10 June 2003
+Last modified: 25 June 2003
</body>
</html>