From 56289a2c103733ea0a8264aaa4db8956f52bfc66 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 6 Jul 2000 11:31:40 -0500 Subject: [svn-r2427] RM_H5T.html H5Tvlen_create: Added cross-reference to H5Dget_vlen_buf_size and H5Dvlen_reclaim. H5Tget_class: Removed numbers from class identifiers list. Added H5T_VLEN to class identifiers list. RM_H5F.html H5Freopen: Corrected description of file_id parameter. Added comment about eventually closing returned identifier. Added clarification that function cannot open closed files. --- doc/html/RM_H5F.html | 22 ++++++++++++++++------ doc/html/RM_H5T.html | 22 +++++++++++++--------- 2 files changed, 29 insertions(+), 15 deletions(-) diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index be8107c..a794332 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -557,22 +557,32 @@ facilitate moving easily between them.
Name: H5Freopen
Signature: -
hid__t H5Freopen(hid_t file_id +
hid_t H5Freopen(hid_t file_id )
Purpose: -
Reopens an HDF5 file. +
Returns a new identifier for a previously-opened HDF5 file.
Description: -
H5Freopen reopens an HDF5 file. The new - file identifier which is returned points to the same file - as the specified file idetifier, file_id. +
H5Freopen returns a new file identifier for an + already-open HDF5 file, as specified by file_id. Both identifiers share caches and other information. The only difference between the identifiers is that the new identifier is not mounted anywhere and no files are mounted on it. +

+ Note that there is no circumstance under which + H5Freopen can actually open a closed file; + the file must already be open and have an active + file_id. E.g., one cannot close a file with + H5Fclose (file_id) then use + H5Freopen (file_id) to reopen it. +

+ The new file identifier should be closed by calling + H5Fclose() when it is no longer needed.

Parameters:
hid_t file_id -
Identifier of a file to terminate access to. +
Identifier of a file for which an additional identifier + is required.
Returns:
Returns a new file identifier if successful; diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 8d42d14..f0a14a4 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -684,6 +684,9 @@ H5Tget_overflow ()
hid_t base_type_id
Base type of datatype to create.
+
See Also: +
H5Dget_vlen_buf_size +
H5Dvlen_reclaim
Returns:
Returns datatype identifier if successful; otherwise returns a negative value. @@ -873,15 +876,16 @@ H5Tget_overflow ()
H5Tget_class returns the datatype class identifier.

Valid class identifiers, as defined in H5Tpublic.h, are: -