summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-07-21 20:46:42 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-07-21 20:46:42 (GMT)
commit2f3da042cf558f96c2f08c1dbd9b1ea2b8b3ffcf (patch)
treecf61965e1cb77aaeb156309f61417a4077a65c48
parent0a8859d5890bc7feaf7bca82f226906879d103f2 (diff)
downloadhdf5-2f3da042cf558f96c2f08c1dbd9b1ea2b8b3ffcf.zip
hdf5-2f3da042cf558f96c2f08c1dbd9b1ea2b8b3ffcf.tar.gz
hdf5-2f3da042cf558f96c2f08c1dbd9b1ea2b8b3ffcf.tar.bz2
[svn-r1524]
RM_H5R.html H5Rget_region Removed "Not yet implemented" note. Corrected syntax to agree with description in H5R.c Added mention of valid 'ref_type' value; deleted reference to User's Guide. H5Rdereference Added list of valid 'ref_type' values; deleted reference to User's Guide. RM_H5T.html H5Tget_class Added H5T_ENUM and H5T_REFERENCE to list of return values. H5Topen Corrected description of 'loc_id'; clarified description of 'name'. H5Tinsert Corrected 'offset' datatype. RM_H5P.html Datasets.html Fixed minor formatting errors. H5Pset_layout H5Pget_layout Added comment that H5D_COMPACT layout type is not yet implemented. H5Pset_external Added note regarding setting 'size' to H5F_UNLIMITED. H5Pset_family (RM_H5P.html only) Removed extra function entry ('original version'). H5Pget_split (RM_H5P.html only) Corrected pair of typos in 'meta_ext' description.
-rw-r--r--doc/html/Datasets.html7
-rw-r--r--doc/html/RM_H5P.html62
-rw-r--r--doc/html/RM_H5R.html22
-rw-r--r--doc/html/RM_H5T.html23
4 files changed, 43 insertions, 71 deletions
diff --git a/doc/html/Datasets.html b/doc/html/Datasets.html
index 0e64468..0cf71e7 100644
--- a/doc/html/Datasets.html
+++ b/doc/html/Datasets.html
@@ -137,7 +137,7 @@ And in this document, the
<br><br>
<dl>
- <dt><code>H5D_COMPACT</code>
+ <dt><code>H5D_COMPACT</code> &nbsp;&nbsp; <i><b>(Not yet implemented.)</b></i>
<dd>The raw data is presumably small and can be stored
directly in the object header. Such data is
non-extendible, non-compressible, non-sparse, and cannot
@@ -145,7 +145,7 @@ And in this document, the
arbitrary but are enforced because of the small size of
the raw data. Storing data in this format eliminates the
disk seek/read request normally necessary to read raw
- data. <b>This layout is not implemented yet.</b>
+ data.
<br><br>
<dt><code>H5D_CONTIGUOUS</code>
@@ -299,7 +299,8 @@ H5Pset_chunk (plist, 2, size);
continues for <em>size</em> bytes. The space represented by this
segment is adjacent to the space already represented by the external
file list. The last segment in a file list may have the size
- <code>H5F_UNLIMITED</em>.
+ <code>H5F_UNLIMITED</em>, in which case the external file may be
+ of unlimited size and no more files can be added to the external files list.
<br><br>
<dt><code>int H5Pget_external_count (hid_t <em>plist</em>)</code>
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html
index f327114..ae126ab 100644
--- a/doc/html/RM_H5P.html
+++ b/doc/html/RM_H5P.html
@@ -713,7 +713,7 @@ parallel HDF5 library.</i>
This function is only valid for dataset creation property lists.
Valid parameters for <code>layout</code> are:
<ul><dl>
- <dt>H5D_COMPACT
+ <dt>H5D_COMPACT &nbsp;&nbsp; <i><b>(Not yet implemented.)</b></i>
<dd>Store raw data and object header contiguously in file.
This should only be used for very small amounts of raw
data (suggested less than 1KB).
@@ -750,7 +750,7 @@ parallel HDF5 library.</i>
a dataset. This function is only valid for dataset creation
property lists. Valid types for <code>layout</code> are:
<ul> <dl>
- <dt>H5D_COMPACT
+ <dt>H5D_COMPACT &nbsp;&nbsp; <i><b>(Not yet implemented.)</b></i>
<dd>Raw data and object header stored contiguously in file.
<dt>H5D_CONTIGUOUS
<dd>Raw data stored separately from object header in one
@@ -925,10 +925,16 @@ parallel HDF5 library.</i>
<p>
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 SIZE arguments for all the external files. If
+ 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>
+ The <code>size</code> argument specifies number of bytes reserved
+ for data in the external file.
+ 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.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
@@ -1557,8 +1563,8 @@ parallel HDF5 library.</i>
<dt><em>size_t</em> <code>meta_ext_size</code>
<dd>IN: Number of characters of the meta file extension to be
copied to the <code>meta_ext</code> buffer.
- <dt><em>OUT</em> <code>*meta_ext</code>
- <dd>IN: Meta file extension.
+ <dt><em>char</em> <code>*meta_ext</code>
+ <dd>OUT: Meta file extension.
<dt><em>hid_t</em> <code>*meta_properties</code>
<dd>OUT: Pointer to a copy of the meta file access property list.
<dt><em>size_t</em> <code>raw_ext_size</code>
@@ -1585,55 +1591,9 @@ parallel HDF5 library.</i>
<em>hid_t</em> <code>memb_plist</code>
)
<dt><strong>Purpose:</strong>
- <dd>Sets the file access properties list to the <em>family</em>
- driver.
- <dt><strong>Description:</strong>
- <dd><i>Original version. Edited version below.</i>
- <dd><code>H5Pset_family</code> sets the file access properties
- to use the <em>family</em>
- driver; any previously defined driver properties are erased
- from the property list. Each member of the file family will
- use <em>member_properties</em> as its file access property
- list. The <em>memb_size</em> argument gives the logical size
- in bytes of each family member but the actual size could be
- smaller depending on whether the file contains holes. The
- member size is only used when creating a new file or
- truncating an existing file; otherwise the member size comes
- from the size of the first member of the family being
- opened. Note: if the size of the <code>off_t</code> type is
- four bytes then the maximum family member size is usually
- 2^31-1 because the byte at offset 2,147,483,647 is generally
- inaccessible. Additional parameters may be added to this
- function in the future.
- <dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>plist</code>
- <dd>IN: Identifier of the file access property list.
- <dt><em>hsize_t</em> <code>memb_size</code>
- <dd>IN: Logical size, in bytes, of each family member.
- <dt><em>hid_t</em> <code>memb_plist</code>
- <dd>IN: Identifier of the file access property list
- for each member of the family.
- </dl>
- <dt><strong>Returns:</strong>
- <dd>Returns a non-negative value if successful;
- otherwise returns a negative value.
-</dl>
-
-
-<hr>
-<dl>
- <dt><strong>Name:</strong> <a name="Property-SetFamily">H5Pset_family</a>
- <dt><strong>Signature:</strong>
- <dd><em>herr_t</em> <code>H5Pset_family</code>(<em>hid_t</em> <code>plist</code>,
- <em>hsize_t</em> <code>memb_size</code>,
- <em>hid_t</em> <code>memb_plist</code>
- )
- <dt><strong>Purpose:</strong>
<dd>Sets the file access properties list to the <code>family</code>
driver.
<dt><strong>Description:</strong>
- <dd><i>Edited version. Original version above.</i>
<dd><code>H5Pset_family</code> sets the file access properties
to use the <code>family</code> driver; any previously defined
driver properties are erased from the property list.
diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html
index d138670..41e401c 100644
--- a/doc/html/RM_H5R.html
+++ b/doc/html/RM_H5R.html
@@ -129,10 +129,12 @@ to specific objects and data regions in an HDF5 file.
opens that object and returns an identifier.
<p>
The parameter <code>ref_type</code> specifies the reference type
- of <code>ref</code>. See
- <a href="References.html#Reference-RefTypes">Reference Types</a> in
- <a href="References.html"><i>References (H5R)</i></a>
- for a list of valid reference types.
+ of <code>ref</code>.
+ <code>ref_type</code> may contain either of the following values:
+ <ul>
+ <li><code>H5R_OBJECT</code> (<code>0</code>)
+ <li><code>H5R_DATASET_REGION</code> (<code>1</code>)
+ </ul>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dataset</code>
@@ -151,9 +153,8 @@ to specific objects and data regions in an HDF5 file.
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Reference-GetRegion">H5Rget_region</a>
-&nbsp;&nbsp;<i>(Not yet implemented.)</i>
<dt><strong>Signature:</strong>
- <dd><em>H5S_t</em> <code>H5Rget_region</code>(<em>H5D_t</em> <code>dataset</code>,
+ <dd><em>hid_t</em> <code>H5Rget_region</code>(<em>hid_t</em> <code>dataset</code>,
<em>H5R_type_t</em> <code>ref_type</code>,
<em>void *</em><code>ref</code>
)
@@ -166,10 +167,11 @@ to specific objects and data regions in an HDF5 file.
which is the region pointed to.
<p>
The parameter <code>ref_type</code> specifies the reference type
- of <code>ref</code>. See
- <a href="References.html#Reference-RefTypes">Reference Types</a> in
- <a href="References.html"><i>References (H5R)</i></a>
- for a list of valid reference types.
+ of <code>ref</code>.
+ <code>ref_type</code> may contain the following value:
+ <ul>
+ <li><code>H5R_DATASET_REGION</code> (<code>1</code>)
+ </ul>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dataset</code>,
diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html
index 19c65ac..f2e6ba9 100644
--- a/doc/html/RM_H5T.html
+++ b/doc/html/RM_H5T.html
@@ -162,9 +162,9 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>A file, group, or datatype identifier.
+ <dd>A file or group identifier.
<dt><em>const char *</em> <code>name</code>
- <dd>A datatype name.
+ <dd>A datatype name, defined within the file or group identified by <code>loc_id</code>.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a named datatype identifier if successful;
@@ -427,9 +427,16 @@ H5Tget_overflow ()
<dt><strong>Description:</strong>
<dd><code>H5Tcreate</code> creates a new dataype of the specified
class with the specified number of bytes.
- Currently, only the <code>H5T_COMPOUND</code> datatype class is
- supported with this function. Use <code>H5Tcopy</code>
- to create integer or floating-point datatypes.
+ <p>
+ The following datatype classes are supported with this function:
+ <ul>
+ <li><code>H5T_COMPOUND</code>
+ <li><code>H5T_OPAQUE</code>
+ <li><code>H5T_ENUM</code>
+ </ul>
+ <p>
+ Use <code>H5Tcopy</code> to create integer or floating-point datatypes.
+ <p>
The datatype identifier returned from this function should be
released with <code>H5Tclose</code> or resource leaks will result.
<dt><strong>Parameters:</strong>
@@ -603,6 +610,8 @@ H5Tget_overflow ()
<li><code>H5T_BITFIELD</code> (<code>4</code>)
<li><code>H5T_OPAQUE</code> (<code>5</code>)
<li><code>H5T_COMPOUND</code> (<code>6</code>)
+ <li><code>H5T_ENUM</code> (<code>7</code>)
+ <li><code>H5T_REFERENCE</code> (<code>8</code>)
</ul>
<dt><strong>Parameters:</strong>
<dl>
@@ -1556,7 +1565,7 @@ zero.
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tinsert</code>(<em>hid_t </em><code>type_id</code>,
<em>const char *</em> <code>name</code>,
- <em>off_t</em> <code>offset</code>,
+ <em>size_t</em> <code>offset</code>,
<em>hid_t</em> <code>field_id</code>
)
<dt><strong>Purpose:</strong>
@@ -1578,7 +1587,7 @@ zero.
<dd>Identifier of compound datatype to modify.
<dt><em>const char *</em> <code>name</code>
<dd>Name of the field to insert.
- <dt><em>off_t</em> <code>offset</code>
+ <dt><em>size_t</em> <code>offset</code>
<dd>Offset in memory structure of the field to insert.
<dt><em>hid_t</em> <code>field_id</code>
<dd>Datatype identifier of the field to insert.