summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5G.html
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-07-06 16:56:15 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-07-06 16:56:15 (GMT)
commitd70b72d630cba4d78cca0f134e6aa26318efff27 (patch)
treee15ba2e8cd116865c0911a5420b6abc7e855e0cc /doc/html/RM_H5G.html
parente186d84c5f19ea24d300f0771994628d87a2848d (diff)
downloadhdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.zip
hdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.tar.gz
hdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.tar.bz2
[svn-r1425]
RM_H5S.html Dataspaces.html H5Sselect_hyperslab H5Sselect_elements Add H5S_SELECT_OR operator. Converted operator list to a table. H5Sextent_copy Corrected source and destination descriptions. (RM_H5S.html only) H5Screate Removed unused H5S_NONE dataspace type. H5Sset_extent_none Corrected reset class type to H5S_NO_CLASS (previously said H5S_NONE). RM_H5G.html H5Gget_linkval Corrected descriptions of 'loc_id', 'name', and 'value'. Corrected "Purpose". Emphasized need to call H5Gget_objinfo first. H5Gset_comment H5Gget_comment Corrected description of 'loc_id'. H5Gget_objinfo Corrected description of 'loc_id'. Added H5G_TYPE to list of valid values of 'type'. RM_H5F.html ExternalFiles.html H5Fmount H5Funmount Corrected description of 'loc_id'. Changed function descriptions in ExternalFiles.html to correspond to RM. RM_H5T.html Moved H5Tget_class and H5Tget_size to "General Datatype Operations" in top index.
Diffstat (limited to 'doc/html/RM_H5G.html')
-rw-r--r--doc/html/RM_H5G.html43
1 files changed, 25 insertions, 18 deletions
diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html
index 4b40efe..469b26d 100644
--- a/doc/html/RM_H5G.html
+++ b/doc/html/RM_H5G.html
@@ -404,8 +404,7 @@ create or access function.
<dt><strong>Description:</strong>
<dd><code>H5Gget_objinfo</code> returns information about the
specified object through the <code>statbuf</code> argument.
- <code>loc_id</code> (a file, group, dataset, or
- named datatype identifier) and
+ <code>loc_id</code> (a file or group identifier) and
<code>name</code> together determine the object.
If the object is a symbolic link and <code>follow_link</code> is
zero (<code>0</code>), then the information returned is that for the link itself;
@@ -438,8 +437,11 @@ create or access function.
symbolic link (symbolic links do not have hard links but
all other objects always have at least one).
The <code>type</code> field contains the type of the object,
- one of <code>H5G_GROUP</code>, <code>H5G_DATASET</code>,
- or <code>H5G_LINK</code>.
+ one of
+ <code>H5G_GROUP</code>,
+ <code>H5G_DATASET</code>,
+ <code>H5G_LINK</code>, or
+ <code>H5G_TYPE</code>.
The <code>mtime</code> field contains the modification time.
If information is being returned about a symbolic link then
<code>linklen</code> will be the length of the link value
@@ -453,7 +455,7 @@ create or access function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: File, group, dataset, or datatype identifier.
+ <dd>IN: File or group identifier.
<dt><em>const char</em> <code>*name</code>
<dd>IN: Name of the object for which status is being sought.
<dt><em>hbool_t</em> <code>follow_link</code>
@@ -478,31 +480,36 @@ create or access function.
<em>char *</em><code>value</code>
)
<dt><strong>Purpose:</strong>
- <dd>Returns link value.
+ <dd>Returns the name of the object that the symbolic link points to.
<dt><strong>Description:</strong>
<dd><code>H5Gget_linkval</code> returns <code>size</code>
- characters of the link value through the <code>value</code>
- argument if <code>loc_id</code> (a file or group identifier)
- and <code>name</code> specify a symbolic link.
- If <code>size</code> is smaller than the link value, then
- <code>value</code> will not be null terminated.
+ characters of the name of the object that the symbolic link <code>name</code> points to.
+ <p>
+ The parameter <code>loc_id</code> is a file or group identifier.
+ <p>
+ The parameter <code>name</code> must be a symbolic link pointing to
+ the desired object and must be defined relative to <code>loc_id</code>.
+ <p>
+ If <code>size</code> is smaller than the size of the returned object name, then
+ the name stored in the buffer <code>value</code> will not be null terminated.
<p>
- This function fails if the specified object is not a symbolic link.
+ This function fails if <code>name</code> is not a symbolic link.
The presence of a symbolic link can be tested by passing zero for
<code>size</code> and NULL for <code>value</code>.
<p>
- Use <code>H5Gget_objinfo()</code> to get the size of a link value.
+ This function should be used only after <code>H5Gget_objinfo()</code> has been called
+ to verify that <code>name</code> is a symbolic link.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of the file, group, dataset, or datatype.
+ <dd>IN: Identifier of the file or group.
<dt><em>const char *</em><code>name</code>
- <dd>IN: Name of the object whose link value is to be checked.
+ <dd>IN: Symbolic link to the object whose name is to be returned.
<dt><em>size_t</em> <code>size</code>
<dd>IN: Maximum number of characters of <code>value</code>
to be returned.
<dt><em>char *</em><code>value</code>
- <dd>OUT: Link value.
+ <dd>OUT: A buffer to hold the name of the object being sought.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value, with the link value in <code>value</code>,
@@ -542,7 +549,7 @@ create or access function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of the file, group, dataset, or datatype.
+ <dd>IN: Identifier of the file or group.
<dt><em>const char *</em><code>name</code>
<dd>IN: Name of the object whose comment is to be set or reset.
<dt><em>const char *</em><code>comment</code>
@@ -579,7 +586,7 @@ create or access function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of the file, group, dataset, or datatype.
+ <dd>IN: Identifier of the file or group.
<dt><em>const char *</em><code>name</code>
<dd>IN: Name of the object whose comment is to be set or reset.
<dt><em>size_t</em> <code>bufsize</code>