From 3cd25f13c918fca96e7d88da3bb1f06e49fe2cac Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 16 Jan 2002 13:51:16 -0500 Subject: [svn-r4838] Purpose: Bugfix. Copy edits and clarification. Description: Added IN/OUT designations to parameters. Copy edits and clarification. Removed () from public H5 functions in running text. Platforms tested: IE 5 --- doc/html/RM_H5D.html | 88 ++++++++++++++++++++++++++++------------------------ 1 file 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. location specified in loc_id.

create_plist_id is a H5P_DATASET_CREATE - property list created with H5Pcreate() and + property list created with H5Pcreate and initialized with the various functions described above. - H5Dcreate() returns a dataset identifier for success + H5Dcreate returns a dataset identifier for success or negative for failure. The identifier should eventually be - closed by calling H5Dclose() to release resources + closed by calling H5Dclose to release resources it uses.

Parameters:
hid_t loc_id -
Identifier of the file or group to create the dataset within. +
IN: Identifier of the file or group + within which to create the dataset.
const char * name -
The name of the dataset to create. +
IN: The name of the dataset to create.
hid_t type_id -
Identifier of the datatype to use when creating the dataset. +
IN: Identifier of the datatype to use + when creating the dataset.
hid_t space_id -
Identifier of the dataspace to use when creating the dataset. +
IN: Identifier of the dataspace to use + when creating the dataset.
hid_t create_plist_id -
Identifier of the set creation property list. +
IN: Identifier of the set creation property list.
Returns:
Returns a dataset identifier if successful; @@ -204,9 +207,10 @@ facilitate moving easily between them.
Parameters:
hid_t loc_id -
Identifier of the file or group to access the dataset within. +
IN: Identifier of the file or group + within which the dataset to be accessed will be found.
const char * name -
The name of the dataset to access. +
IN: The name of the dataset to access.
Returns:
Returns a dataset identifier if successful; @@ -233,11 +237,11 @@ facilitate moving easily between them.
H5Dget_space returns an identifier for a copy of the dataspace for a dataset. The dataspace identifier should be released with the - H5Sclose() function. + H5Sclose function.
Parameters:
hid_t dataset_id -
Identifier of the dataset to query. +
IN: Identifier of the dataset to query.
Returns:
Returns a dataspace identifier if successful; @@ -263,7 +267,7 @@ facilitate moving easily between them.
Description:
H5Dget_type returns an identifier for a copy of the datatype for a dataset. - The datatype should be released with the H5Tclose() function. + The datatype should be released with the H5Tclose function.

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.

Parameters:
hid_t dataset_id -
Identifier of the dataset to query. +
IN: Identifier of the dataset to query.
Returns:
Returns a datatype identifier if successful; @@ -300,11 +304,11 @@ facilitate moving easily between them.
H5Dget_create_plist 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 H5Pclose() function. + the H5Pclose function.
Parameters:
hid_t dataset_id -
Identifier of the dataset to query. +
IN: Identifier of the dataset to query.
Returns:
Returns a dataset creation property list identifier if successful; @@ -336,7 +340,7 @@ facilitate moving easily between them.
Parameters:
hid_t dataset_id -
Identifier of the dataset to query. +
IN: Identifier of the dataset to query.
Returns:
Returns the amount of storage space allocated for the dataset, @@ -376,13 +380,13 @@ facilitate moving easily between them.
Parameters:
hid_t dataset_id -
Identifier of the dataset to query. +
IN: Identifier of the dataset to query.
hid_t type_id -
Datatype identifier. +
IN: Datatype identifier.
hid_t space_id -
Dataspace identifier. +
IN: Dataspace identifier.
hsize_t *size -
The size in bytes of the memory buffer required to store the VL data. +
OUT: The size in bytes of the memory buffer required to store the VL data.
Returns:
Returns non-negative value if successful; @@ -429,13 +433,13 @@ facilitate moving easily between them.
Parameters:
hid_t type_id -
Identifier of the datatype. +
IN: Identifier of the datatype.
hid_t space_id -
Identifier of the dataspace. +
IN: Identifier of the dataspace.
hid_t plist_id -
Identifier of the property list used to create the buffer. +
IN: Identifier of the property list used to create the buffer.
void *buf -
Pointer to the buffer to be reclaimed. +
IN: Pointer to the buffer to be reclaimed.
Returns:
Returns non-negative value if successful; @@ -590,17 +594,18 @@ facilitate moving easily between them.
Parameters:
hid_t dataset_id -
Identifier of the dataset read from. +
IN: Identifier of the dataset read from.
hid_t mem_type_id -
Identifier of the memory datatype. +
IN: Identifier of the memory datatype.
hid_t mem_space_id -
Identifier of the memory dataspace. +
IN: Identifier of the memory dataspace.
hid_t file_space_id -
Identifier of the dataset's dataspace in the file. +
IN: Identifier of the dataset's dataspace in the file.
hid_t xfer_plist_id -
Identifier of a transfer property list for this I/O operation. +
IN: Identifier of a transfer property list + for this I/O operation.
void * buf -
Buffer to receive data read from file. +
OUT: Buffer to receive data read from file.
Returns:
Returns a non-negative value if successful; @@ -758,17 +763,18 @@ facilitate moving easily between them.
Parameters:
hid_t dataset_id -
Identifier of the dataset to write to. +
IN: Identifier of the dataset to write to.
hid_t mem_type_id -
Identifier of the memory datatype. +
IN: Identifier of the memory datatype.
hid_t mem_space_id -
Identifier of the memory dataspace. +
IN: Identifier of the memory dataspace.
hid_t file_space_id -
Identifier of the dataset's dataspace in the file. +
IN: Identifier of the dataset's dataspace in the file.
hid_t xfer_plist_id -
Identifier of a transfer property list for this I/O operation. +
IN: Identifier of a transfer property list + for this I/O operation.
const void * buf -
Buffer with data to be written to the file. +
IN: Buffer with data to be written to the file.
Returns:
Returns a non-negative value if successful; @@ -800,9 +806,9 @@ facilitate moving easily between them.
Parameters:
hid_t dataset_id -
Identifier of the dataset. +
IN: Identifier of the dataset.
const hsize_t * size -
Array containing the new magnitude of each dimension. +
IN: Array containing the new magnitude of each dimension.
Returns:
Returns a non-negative value if successful; @@ -833,7 +839,7 @@ facilitate moving easily between them.
Parameters:
hid_t dataset_id -
Identifier of the dataset to finish access to. +
IN: Identifier of the dataset to close access to.
Returns:
Returns a non-negative value if successful; @@ -946,7 +952,7 @@ H5D   HDF Help Desk
-Last modified: 13 November 2000 +Last modified: 8 October 2001
Describes HDF5 Release 1.5, Unreleased Development Branch -- cgit v0.12