summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5G.html
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2004-12-29 14:26:20 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2004-12-29 14:26:20 (GMT)
commit427ff7da2848042f68ecfadf5a321b1d8077e9db (patch)
tree73024b1954031fbb724c2d96a485590348e5cc22 /doc/html/RM_H5G.html
parent9b96fd2003ae74cca389cc4c2216b4371d6eb173 (diff)
downloadhdf5-427ff7da2848042f68ecfadf5a321b1d8077e9db.zip
hdf5-427ff7da2848042f68ecfadf5a321b1d8077e9db.tar.gz
hdf5-427ff7da2848042f68ecfadf5a321b1d8077e9db.tar.bz2
[svn-r9727] Purpose:
Bug Fix/Code Cleanup/Doc Cleanup/Optimization/Branch Sync :-) Description: Generally speaking, this is the "signed->unsigned" change to selections. However, in the process of merging code back, things got stickier and stickier until I ended up doing a big "sync the two branches up" operation. So... I brought back all the "infrastructure" fixes from the development branch to the release branch (which I think were actually making some improvement in performance) as well as fixed several bugs which had been fixed in one branch, but not the other. I've also tagged the repository before making this checkin with the label "before_signed_unsigned_changes". Platforms tested: FreeBSD 4.10 (sleipnir) w/parallel & fphdf5 FreeBSD 4.10 (sleipnir) w/threadsafe FreeBSD 4.10 (sleipnir) w/backward compatibility Solaris 2.7 (arabica) w/"purify options" Solaris 2.8 (sol) w/FORTRAN & C++ AIX 5.x (copper) w/parallel & FORTRAN IRIX64 6.5 (modi4) w/FORTRAN Linux 2.4 (heping) w/FORTRAN & C++ Misc. update:
Diffstat (limited to 'doc/html/RM_H5G.html')
-rw-r--r--doc/html/RM_H5G.html40
1 files changed, 34 insertions, 6 deletions
diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html
index 717667e..7284051 100644
--- a/doc/html/RM_H5G.html
+++ b/doc/html/RM_H5G.html
@@ -204,6 +204,7 @@ create or access function.
<p>
<!-- NEW PAGE -->
+<!-- HEADER RIGHT " " -->
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Gclose" -->
<hr>
@@ -550,7 +551,8 @@ SUBROUTINE
The existence of an object can be tested by calling this function
with a null <code>statbuf</code>.
<p>
- <code>H5Gget_objinfo</code> fills in the following data structure:
+ <code>H5Gget_objinfo</code> fills in the following data structure
+ (defined in H5Gpublic.h):
<pre>
typedef struct H5G_stat_t {
unsigned long fileno;
@@ -562,9 +564,20 @@ SUBROUTINE
H5O_stat_t ohdr;
} H5G_stat_t
</pre>
+
+ where H5O_stat_t (defined in H5Opublic.h) is:
+
+ <pre>
+ typedef struct H5O_stat_t {
+ hsize_t size;
+ hsize_t free;
+ unsigned nmesgs;
+ unsigned nchunks;
+ } H5O_stat_t
+ </pre>
The <code>fileno</code> and <code>objno</code> fields contain
- values which uniquely identify an object among those
- HDF5 files which are open: if both values are the same
+ four values which uniquely identify an object among those
+ HDF5 files which are open: if all four values are the same
between two objects, then the two objects are the same
(provided both files are still open).
<ul>
@@ -580,26 +593,41 @@ SUBROUTINE
the object or zero when information is being returned about a
symbolic link (symbolic links do not have hard links but
all other objects always have at least one).
+ <p>
The <code>type</code> field contains the type of the object,
one of
<code>H5G_GROUP</code>,
<code>H5G_DATASET</code>,
<code>H5G_LINK</code>, or
<code>H5G_TYPE</code>.
+ <p>
The <code>mtime</code> field contains the modification time.
+ <p>
If information is being returned about a symbolic link then
<code>linklen</code> will be the length of the link value
(the name of the pointed-to object with the null terminator);
otherwise <code>linklen</code> will be zero.
+ <p>
+ The fields in the <code>H5O_stat_t</code> struct contain information
+ about the object header for the object queried:
+ <ul><dl>
+ <dt><code>size</code>
+ <dd>The total size of all the object header information in
+ the file (for all chunks).
+ <dt><code>free</code>
+ <dd>The size of unused space in the object header.
+ <dt><code>nmesgs</code>
+ <dd>The number of object header messages.
+ <dt><code>nchunks</code>
+ <dd>The number of chunks the object header is broken up into.
+ </dl> </ul>
-<!-- INSERT H50_stat_t DESCRIPTION AS IN 1.6 -->
-
+ <p>
Other fields may be added to this structure in the future.
<dt><strong>Note:</strong>
<dd>Some systems will be able to record the time accurately but
unable to retrieve the correct time; such systems (e.g., Irix64)
will report an <code>mtime</code> value of 0 (zero).
-<!-- NEW PAGE -->
<dt><strong>Parameters:</strong>
<ul><table>
<tr>