summaryrefslogtreecommitdiffstats
path: root/doc/html/Groups.html
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2000-11-01 19:01:55 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2000-11-01 19:01:55 (GMT)
commit180a47a037320fc8fcf48cf3114e1f548d019659 (patch)
tree62cc16e0b2fce361493884f9a7c3f4e322fb969d /doc/html/Groups.html
parent6d04c130ad005d0b34f73592f9a3722e8bf7cdf4 (diff)
downloadhdf5-180a47a037320fc8fcf48cf3114e1f548d019659.zip
hdf5-180a47a037320fc8fcf48cf3114e1f548d019659.tar.gz
hdf5-180a47a037320fc8fcf48cf3114e1f548d019659.tar.bz2
[svn-r2789] Purpose:
To warn users that RM_H5G.html and Groups.html can render groups and datasets inaccessible in a file. Solution: Modified RM_H5G.html and Groups.html as follows: -- Added warning (new section) to Groups.html that H5Gunlink and H5Gmove can result in inaccessible groups and datasets. -- Added links to that new section from H5Gunlink and H5Gmove in RM_H5G.html. Platforms tested: IE5
Diffstat (limited to 'doc/html/Groups.html')
-rw-r--r--doc/html/Groups.html29
1 files changed, 28 insertions, 1 deletions
diff --git a/doc/html/Groups.html b/doc/html/Groups.html
index 44ca0fb..be5844f 100644
--- a/doc/html/Groups.html
+++ b/doc/html/Groups.html
@@ -307,6 +307,33 @@
string is returned.
</dl>
+ <a name="H5GUnlinkToCorrupt">
+ <h2>6. Unlinking Datasets with H5Gmove and H5Gunlink</h2>
+ </a>
+
+ <p>Exercise caution in the use of <code>H5Gmove</code> and
+ <code>H5Gunlink</code>.
+
+ <p>Note that <code>H5Gmove</code> and <code>H5Gunlink</code>
+ each include a step that unlinks pointers to a set or group.
+ If the link that is removed is on the only path leading
+ to a dataset or group, that dataset or group will become
+ inaccessible in the file.
+
+ <p>Consider the following example. Assume that the group
+ <code>group2</code> can only be accessed via the following path,
+ where <code>top_group</code> is a member of the file's root group:
+ <pre>
+ <code>/top_group/group1/group2/</code> </pre>
+ Using <code>H5Gmove</code>, <code>top_group</code> is renamed
+ to be a member of <code>group2</code>. At this point, since
+ <code>top_group</code> was the only route from the root group
+ to <code>group1</code>, there is no longer a path by which
+ one can access <code>group1</code>, <code>group2</code>, or
+ any member datasets.
+ <code>top_group</code> and any member datasets have also
+ become inaccessible.
+
<hr>
<center>
@@ -359,7 +386,7 @@
<!-- Created: Tue Jan 27 09:11:27 EST 1998 -->
<!-- hhmts start -->
-Last modified: 14 October 1999
+Last modified: 1 November 2000
<!-- hhmts end -->
</body>