From 0df268326638c10990c913d5964af3ac6812a266 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 24 Aug 2004 16:02:45 -0500 Subject: [svn-r9148] Purpose: Heavy edit to existing H5Iget_file_id entry Restructure function index at top of page Platforms tested: Mozilla --- doc/html/RM_H5I.html | 82 +++++++++++++++++++++++++++++----------------------- 1 file changed, 46 insertions(+), 36 deletions(-) diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index be43068..676d12a 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -77,29 +77,29 @@ object names.
             
@@ -158,17 +158,17 @@ as the corresponding C function.
             
@@ -390,33 +390,43 @@ END SUBROUTINE h5idec_ref_f
Signature:
hid_t H5Iget_file_id(hid_t obj_id)
Purpose: -
Retrieves the ID of the file associated with the object referenced by obj_id. +
Retrieves an identifier for the file containing the specified object.
Description: -
H5Iget_file_id returns the ID of the file associated with the - object referenced by obj_id. The retrieved file ID must be closed - using H5Fclose. - +
H5Iget_file_id returns the identifier of the file + associated with the object referenced by obj_id. +

+ obj_id can be a file, group, dataset, named datatype, + or attribute identifier.

- Currently, obj_id can be the ID of one of the following objects: - a file, a named datatype, a group, a dataset, or an attribute. + Note that the HDF5 Library permits an application to close a file + while objects within the file remain open. + If the file containing the object obj_id + is still open, H5Iget_file_id will retrieve the + existing file identifier. + If there is no existing file identifier for the file, + i.e., the file has been closed, + H5Iget_file_id will reopen the file and + return a new file identifier. + In either case, the file identifier must eventually be released + using H5Fclose.

Parameters: +
Returns: -
Returns the file ID on success, negative on failure. +
Returns a file identifier on success, negative on failure.
Fortran90 Interface: -
This function is currently not supported in FORTRAN 90. - - @@ -783,7 +793,7 @@ END SUBROUTINE h5iinc_ref_f
-
Name: H5Inmembers +
Name: H5Inmembers
Signature:
int H5Inmembers(H5I_type_t type)
Purpose: @@ -1148,7 +1158,7 @@ And in this document, the Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 -- cgit v0.12