diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/RM_H5D.html | 88 |
1 files changed, 47 insertions, 41 deletions
diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 615bff7..3d96e56 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -156,24 +156,27 @@ facilitate moving easily between them.</i> location specified in <code>loc_id</code>. <p> <code>create_plist_id</code> is a <code>H5P_DATASET_CREATE</code> - property list created with <code>H5Pcreate()</code> and + property list created with <code>H5Pcreate</code> and initialized with the various functions described above. - <code>H5Dcreate()</code> returns a dataset identifier for success + <code>H5Dcreate</code> returns a dataset identifier for success or negative for failure. The identifier should eventually be - closed by calling <code>H5Dclose()</code> to release resources + closed by calling <code>H5Dclose</code> to release resources it uses. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>Identifier of the file or group to create the dataset within. + <dd>IN: Identifier of the file or group + within which to create the dataset. <dt><em>const char *</em> <code>name</code> - <dd>The name of the dataset to create. + <dd>IN: The name of the dataset to create. <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of the datatype to use when creating the dataset. + <dd>IN: Identifier of the datatype to use + when creating the dataset. <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of the dataspace to use when creating the dataset. + <dd>IN: Identifier of the dataspace to use + when creating the dataset. <dt><em>hid_t</em> <code>create_plist_id</code> - <dd>Identifier of the set creation property list. + <dd>IN: Identifier of the set creation property list. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataset identifier if successful; @@ -204,9 +207,10 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>Identifier of the file or group to access the dataset within. + <dd>IN: Identifier of the file or group + within which the dataset to be accessed will be found. <dt><em>const char *</em> <code>name</code> - <dd>The name of the dataset to access. + <dd>IN: The name of the dataset to access. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataset identifier if successful; @@ -233,11 +237,11 @@ facilitate moving easily between them.</i> <dd><code>H5Dget_space</code> returns an identifier for a copy of the dataspace for a dataset. The dataspace identifier should be released with the - <code>H5Sclose()</code> function. + <code>H5Sclose</code> function. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset to query. + <dd>IN: Identifier of the dataset to query. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; @@ -263,7 +267,7 @@ facilitate moving easily between them.</i> <dt><strong>Description:</strong> <dd><code>H5Dget_type</code> returns an identifier for a copy of the datatype for a dataset. - The datatype should be released with the <code>H5Tclose()</code> function. + The datatype should be released with the <code>H5Tclose</code> function. <p> If a dataset has a named datatype, then an identifier to the opened datatype is returned. @@ -272,7 +276,7 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset to query. + <dd>IN: Identifier of the dataset to query. </dl> <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; @@ -300,11 +304,11 @@ facilitate moving easily between them.</i> <dd><code>H5Dget_create_plist</code> returns an identifier for a copy of the dataset creation property list for a dataset. The creation property list identifier should be released with - the <code>H5Pclose()</code> function. + the <code>H5Pclose</code> function. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset to query. + <dd>IN: Identifier of the dataset to query. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataset creation property list identifier if successful; @@ -336,7 +340,7 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset to query. + <dd>IN: Identifier of the dataset to query. </dl> <dt><strong>Returns:</strong> <dd>Returns the amount of storage space allocated for the dataset, @@ -376,13 +380,13 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset to query. + <dd>IN: Identifier of the dataset to query. <dt><em>hid_t</em> <code>type_id</code> - <dd>Datatype identifier. + <dd>IN: Datatype identifier. <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. + <dd>IN: Dataspace identifier. <dt><em>hsize_t</em> *<code>size</code> - <dd>The size in bytes of the memory buffer required to store the VL data. + <dd>OUT: The size in bytes of the memory buffer required to store the VL data. </dl> <dt><strong>Returns:</strong> <dd>Returns non-negative value if successful; @@ -429,13 +433,13 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of the datatype. + <dd>IN: Identifier of the datatype. <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of the dataspace. + <dd>IN: Identifier of the dataspace. <dt><em>hid_t</em> <code>plist_id</code> - <dd>Identifier of the property list used to create the buffer. + <dd>IN: Identifier of the property list used to create the buffer. <dt><em>void</em> *<code>buf</code> - <dd>Pointer to the buffer to be reclaimed. + <dd>IN: Pointer to the buffer to be reclaimed. </dl> <dt><strong>Returns:</strong> <dd>Returns non-negative value if successful; @@ -590,17 +594,18 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset read from. + <dd>IN: Identifier of the dataset read from. <dt><em>hid_t</em> <code>mem_type_id</code> - <dd>Identifier of the memory datatype. + <dd>IN: Identifier of the memory datatype. <dt><em>hid_t</em> <code>mem_space_id</code> - <dd>Identifier of the memory dataspace. + <dd>IN: Identifier of the memory dataspace. <dt><em>hid_t</em> <code>file_space_id</code> - <dd>Identifier of the dataset's dataspace in the file. + <dd>IN: Identifier of the dataset's dataspace in the file. <dt><em>hid_t</em> <code>xfer_plist_id</code> - <dd>Identifier of a transfer property list for this I/O operation. + <dd>IN: Identifier of a transfer property list + for this I/O operation. <dt><em>void *</em> <code>buf</code> - <dd>Buffer to receive data read from file. + <dd>OUT: Buffer to receive data read from file. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; @@ -758,17 +763,18 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset to write to. + <dd>IN: Identifier of the dataset to write to. <dt><em>hid_t</em> <code>mem_type_id</code> - <dd>Identifier of the memory datatype. + <dd>IN: Identifier of the memory datatype. <dt><em>hid_t</em> <code>mem_space_id</code> - <dd>Identifier of the memory dataspace. + <dd>IN: Identifier of the memory dataspace. <dt><em>hid_t</em> <code>file_space_id</code> - <dd>Identifier of the dataset's dataspace in the file. + <dd>IN: Identifier of the dataset's dataspace in the file. <dt><em>hid_t</em> <code>xfer_plist_id</code> - <dd>Identifier of a transfer property list for this I/O operation. + <dd>IN: Identifier of a transfer property list + for this I/O operation. <dt><em>const void *</em> <code>buf</code> - <dd>Buffer with data to be written to the file. + <dd>IN: Buffer with data to be written to the file. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; @@ -800,9 +806,9 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset. + <dd>IN: Identifier of the dataset. <dt><em>const hsize_t *</em> <code>size</code> - <dd>Array containing the new magnitude of each dimension. + <dd>IN: Array containing the new magnitude of each dimension. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; @@ -833,7 +839,7 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> - <dd>Identifier of the dataset to finish access to. + <dd>IN: Identifier of the dataset to close access to. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; @@ -946,7 +952,7 @@ H5D <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 13 November 2000 +Last modified: 8 October 2001 <br> Describes HDF5 Release 1.5, Unreleased Development Branch |