From 5228ba6c718e5eaf416a4ac6fdc8a9d32e234333 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Fri, 7 Apr 2000 14:38:42 -0500 Subject: [svn-r2090] RM_H5D.html H5Dclose: Corrected return type to herr_t (was hid_t). H5Dcreate: Inserted missing spaces in function syntax statement. RM_H5E.html H5Ewalk: Added H5E_walk_t prototype and prototype parameter descriptions. RM_H5F.html H5Fclose: Corrected behavior description, eliminating comment that function fials if other access identifiers are still open and describing actual behavior. RM_H5T.html H5Tregister: Corrected possible 'pers' values to H5T_PERS_HARD (was HARD) and H5T_PERS_SOFT (was SOFT). H5Tfind: Corrected 'pcdata' parameter IN/OUT designation. --- doc/html/RM_H5D.html | 8 ++++---- doc/html/RM_H5E.html | 24 ++++++++++++++++++++++++ doc/html/RM_H5F.html | 16 +++++++++++++--- doc/html/RM_H5T.html | 28 ++++++++++++++++------------ 4 files changed, 57 insertions(+), 19 deletions(-) diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 1473dc3..2e27f94 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -132,9 +132,9 @@ facilitate moving easily between them.
Signature:
hid_t H5Dcreate(hid_t loc_id, const char *name, - hid_ttype_id, - hid_tspace_id, - hid_tcreate_plist_id + hid_t type_id, + hid_t space_id, + hid_t create_plist_id )
Purpose:
Creates a dataset at the specified location. @@ -643,7 +643,7 @@ facilitate moving easily between them.
Name: H5Dclose
Signature: -
hid_t H5Dclose(hid_t dataset_id +
herr_t H5Dclose(hid_t dataset_id )
Purpose:
Closes the specified dataset. diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index c0b1e66..7b632a7 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -244,6 +244,30 @@ errors within the H5E package. regardless of stack traversal direction), an error stack entry, and the client_data pointer passed to H5E_print. + The H5E_walk_t prototype is as follows: + +

+ typedef herr_t (*H5E_walk_t)(int n, + H5E_error_t *err_desc, + void *client_data) +

+ where the parameters have the following meanings: +

+
int n +
Indexed position of the error in the stack. +
H5E_error_t *err_desc +
Pointer to a data structure describing the error. + (This structure is currently described only in the + source code file hdf5/src/H5Epublic.h. + That file also contains the definitive list of major + and minor error codes. That information will + eventually be presented as an appendix to this + Reference Manual.) +
void *client_data +
Pointer to client data in the format expected by + the user-defined function. +
+

H5Ewalk can fail if there are problems initializing the library. diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index 27843b8..be8107c 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -429,9 +429,19 @@ facilitate moving easily between them.

Terminates access to an HDF5 file.
Description:
H5Fclose terminates access to an HDF5 file. - If this is the last file identifier open for a file - and if access identifiers are still in use, - this function will fail. +

+ If this is the last file identifier open for the file + and no other access identifier is open (e.g., a dataset + identifier, group identifier, or shared datatype identifier), + the file will be fully closed and access will end. +

+ If this is the last file identifier open for the file + and other access identifiers are still in use, + those access identifiers remain valid until separately + closed and can still be used. + (But the file identifier is no longer valid and cannot be used.) + Once all of the remaining access identifiers are closed, + the file will be fully closed and access will end.

Parameters:
hid_t file_id diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index f49c490..8d42d14 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -461,7 +461,7 @@ in the HDF5 User's Guide for further information, including a compl
hid_t dst_id
IN: Identifier for the destination datatype.
H5T_cdata_t **pcdata -
IN: Pointer to type conversion data. +
OUT: Pointer to type conversion data.
Returns:
Returns a pointer to a suitable conversion function if successful. @@ -2246,16 +2246,18 @@ zero. for a datatype conversion path.

The parameter pers indicates whether a conversion function - is HARD or SOFT. + is hard (H5T_PERS_HARD) + or soft (H5T_PERS_SOFT).

A conversion path can have only one hard function. - When pers is HARD, func replaces - any previous hard function. - If pers is HARD and func - is the null pointer, then any hard function registered for this - path is removed. + When pers is H5T_PERS_HARD, + func replaces any previous hard function. + If pers is H5T_PERS_HARD and + func is the null pointer, then any hard function + registered for this path is removed.

- When pers is SOFT, H5Tregister + When pers is H5T_PERS_SOFT, + H5Tregister adds the function to the end of the master soft list and replaces the soft function in all applicable existing conversion paths. Soft functions are used when determining which conversion function @@ -2275,14 +2277,16 @@ zero. hid_t dst_id, H5T_cdata_t *cdata, size_t nelmts, + size_t stride, void *buf, - void *bkg); + void *bkg, + hid_t dset_xfer_plist);

Parameters:
H5T_pers_t pers -
HARD for hard conversion functions; - SOFT for soft conversion functions. +
H5T_PERS_HARD for hard conversion functions; + H5T_PERS_SOFT for soft conversion functions.
const char * name
Name displayed in diagnostic output.
hid_t src_id @@ -2682,7 +2686,7 @@ H5T   HDF Help Desk
-Last modified: 20 October 1999 +Last modified: 7 April 2000 -- cgit v0.12