[svn-r14896] Description:

    H5Iget_name:  Clarify 'size' description: "'size' must be the size in 
        bytes of the object name plus 1 for a NULL terminator."
    -- Closes Bugzilla entry 1125.
    Minor code formattting.
Tested: Firefox

1 files changed, 21 insertions, 18 deletions

diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html
index 7ff24a5..4169701 100644
--- a/doc/html/RM_H5I.html
+++ b/doc/html/RM_H5I.html
@@ -358,15 +358,16 @@ END SUBROUTINE h5iget_file_id_f
         <code>name</code>; additional characters, if any, are not returned
         to the user application.
         <p>
-	If the length of the name, which determines the required 
-	value of <code>size</code>, is unknown, a preliminary  
-	<code>H5Iget_name</code> call can be made.  
-	The return value of this call will be the size of the 
-	object name.  
-	That value can then be assigned to <code>size</code> 
-	for a second <code>H5Iget_name</code> call, 
-	which will retrieve the actual name.
-	<p>
+        If the length of the name, which determines the required 
+        value of <code>size</code>, is unknown, a preliminary  
+        <code>H5Iget_name</code> call can be made.  
+        The return value of this call will be the size in bytes of the 
+        object name.  
+        That value, plus 1 for a <small>NULL</small> terminator, 
+        is then assigned to <code>size</code> 
+        for a second <code>H5Iget_name</code> call, 
+        which will retrieve the actual name.
+        <p>
         If the object identified by <code>obj_id</code> is an attribute,
         as determined via 
         <a href="#Identify-GetType"><code>H5Iget_type</code></a>,
@@ -374,18 +375,18 @@ END SUBROUTINE h5iget_file_id_f
         to which that attribute is attached. 
         To retrieve the name of the attribute itself, use
         <a href="RM_H5A.html#Annot-GetName"><code>H5Aget_name</code></a>.
-        <p>     
+        <p>
         If there is no name associated with the object identifier
-	or if the name is <code>NULL</code>, <code>H5Iget_name</code>
+        or if the name is <code>NULL</code>, <code>H5Iget_name</code>
         returns <code>0</code> (zero).
-	<p>
+        <p>
         <code>H5Iget_name</code> cannot be used with an object identifier
         returned by <code>H5Rdereference</code>;  
         the function will not be able to determine a valid object name.
-	<p>
-	Note that an object in an HDF5 file may have multiple names,
-	varying according to the path through the HDF5 group 
-	hierarchy used to reach that object.
+        <p>
+        Note that an object in an HDF5 file may have multiple names,
+        varying according to the path through the HDF5 group 
+        hierarchy used to reach that object.
 <dt><strong>Parameters:</strong> 
     <ul><table>
       <tr>
@@ -398,7 +399,9 @@ END SUBROUTINE h5iget_file_id_f
         <td valign="top">OUT: A name associated with the identifier.</td></tr>
       <tr>
         <td valign="top"><em>size_t</em> <code>size</code></td> 
-        <td valign="top">IN: The size of the <code>name</code> buffer.</td></tr>
+        <td valign="top">IN: The size of the <code>name</code> buffer;
+            must be the size of the name in bytes 
+            plus 1 for a <small>NULL</small> terminator.</td></tr>
     </table></ul>
 <dt><strong>Returns:</strong> 
     <dd>Returns the length of the name if successful, returning <code>0</code> 
@@ -731,7 +734,7 @@ Describes HDF5 Release 1.6.7, January 2008
 
 <!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
 <!--
-document.writeln("Last modified: 20 March 2008");
+document.writeln("Last modified: 29 April 2008");
 -->
 </SCRIPT>