svn commit - mysqldoc@docsrva: r5104 - trunk/ndbapi

[jon]

Author: jstephens
Date: 2007-02-28 06:55:34 +0100 (Wed, 28 Feb 2007)
New Revision: 5104

Log:


Second argument to NdbOperation::getValue() is optional; added info on 
differences in handling of integer and character data by this method
(Thanks, Hartmut!)



Modified:
   trunk/ndbapi/ndb-classes.xml


Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml	2007-02-27 22:54:35 UTC (rev 5103)
+++ trunk/ndbapi/ndb-classes.xml	2007-02-28 05:55:34 UTC (rev 5104)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 3; 1761 bytes

@@ -27791,9 +27791,11 @@
 
 
           <para>
-            All three forms of this method require two parameters. They
-            differ with regard to the type of the first parameter, which
-            can be any one of the following:
+            All three forms of this method have two parameters, the
+            second parameter being optional (defaults to
+            <literal>0</literal>). They differ with regard to the type
+            of the first parameter, which can be any one of the
+            following:
 
             <itemizedlist>
 

@@ -27826,6 +27828,22 @@
             method.
           </para>
         </formalpara>
+        
+        <para>
+          Integer values can be retrieved from both the
+          <replaceable>value</replaceable> buffer passed as this
+          method's second parameter, and from the
+          <literal>NdbRecAttr</literal> object itself. On the other
+          hand, character data is available from
+          <literal>NdbRecAttr</literal> (see  
+          <xref linkend="class-ndbrecattr-aref"/>) only if no buffer was
+          passed in to <literal>getValue()</literal>. However, character
+          data is written to the buffer only if one is provided, in
+          which case it cannot be retrieved from the
+          <literal>NdbRecAttr</literal> object that was returned. In the 
+          latter case, <literal>NdbRecAttr::aRef()</literal> returns a
+          buffer pointing to an empty string.
+        </para>
 
         <formalpara>
           <title>Return Value</title>