summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5P.html
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2004-07-02 15:50:02 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2004-07-02 15:50:02 (GMT)
commit9c19127e546703117f64082d1af6ba433f7775f5 (patch)
tree61dda119cc7057eccf4d2bdae8ac692fa4e5caab /doc/html/RM_H5P.html
parentd100f26a7ccb397e746ec1a3f97ec91fc8a4b978 (diff)
downloadhdf5-9c19127e546703117f64082d1af6ba433f7775f5.zip
hdf5-9c19127e546703117f64082d1af6ba433f7775f5.tar.gz
hdf5-9c19127e546703117f64082d1af6ba433f7775f5.tar.bz2
[svn-r8789]
Purpose: To more carefully describe the behavior of H5Pset_external. Description: Add notes that first H5Pset_external call sets the dataset as EXTERNAL and identifies the first file in the series of external files that will hold the dataset; subsequent calls identify additional files; all external files must be declared before the dataset is created; and the library will create files that don't yet exist on the system at the time that H5Dwrite is called to write data to that file. Also a few copy edits. Platforms tested: Mozilla
Diffstat (limited to 'doc/html/RM_H5P.html')
-rw-r--r--doc/html/RM_H5P.html26
1 files changed, 20 insertions, 6 deletions
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html
index 8975669..45b8e92 100644
--- a/doc/html/RM_H5P.html
+++ b/doc/html/RM_H5P.html
@@ -5944,13 +5944,19 @@ END SUBROUTINE h5pset_edc_check_f
<dt><strong>Purpose:</strong>
<dd>Adds an external file to the list of external files.
<dt><strong>Description:</strong>
- <dd><code>H5Pset_external</code> adds an external file to the
- list of external files.
+ <dd>The first call to <code>H5Pset_external</code> sets the
+ <i>external storage</i> property in the property list,
+ thus designating that the dataset will be stored in
+ one or more non-HDF5 file(s) external to the HDF5 file.
+ This call also adds the file <code>name</code> as the
+ first file in the list of external files.
+ Subsequent calls to the function add the named file as
+ the next file in the list.
<p>
- If a dataset is split across multiple files then the files
+ If a dataset is split across multiple files, then the files
should be defined in order. The total size of the dataset is
- the sum of the <code>size</code> arguments for all the external files. If
- the total size is larger than the size of a dataset then the
+ the sum of the <code>size</code> arguments for all the external files.
+ If the total size is larger than the size of a dataset then the
dataset can be extended (provided the data space also allows
the extending).
<p>
@@ -5959,6 +5965,14 @@ END SUBROUTINE h5pset_edc_check_f
If <code>size</code> is set to <code>H5F_UNLIMITED</code>, the
external file can be of unlimited size and no more files can be added to
the external files list.
+ <p>
+ All of the external files for a given dataset must be
+ specified with <code>H5Pset_external</code>
+ <i>before</i> <code>H5Dcreate</code> is called to create
+ the dataset.
+ If one these files does not exist on the system when
+ <code>H5Dwrite</code> is called to write data to it,
+ the library will create the file.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
@@ -9194,7 +9208,7 @@ And in this document, the
Describes HDF5 Release 1.6.2, February 2004
</address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
<!--
-document.writeln("Last modified: 24 June 2004");
+document.writeln("Last modified: 2 July 2004");
-->
</SCRIPT>