MySQL Lists are EOL. Please join:

List:Commits« Previous MessageNext Message »
From:jon Date:July 2 2006 11:44am
Subject:svn commit - mysqldoc@docsrva: r2588 - trunk/ndbapi
View as plain text  
Author: jstephens
Date: 2006-07-02 13:44:05 +0200 (Sun, 02 Jul 2006)
New Revision: 2588

Log:
Added NdbRecAttr class and member descriptions; updated Makefile.

Modified:
   trunk/ndbapi/Makefile
   trunk/ndbapi/ndb-classes.xml

Modified: trunk/ndbapi/Makefile
===================================================================
--- trunk/ndbapi/Makefile	2006-07-02 06:46:28 UTC (rev 2587)
+++ trunk/ndbapi/Makefile	2006-07-02 11:44:05 UTC (rev 2588)
@@ -31,7 +31,7 @@
 
 NDBAPI_SRCS_EXTRA = ndb.en.ent
 
-NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml getting-started.xml mgm-api.xml ndb-classes.xml images/Ndb-class.png images/Ndb-cluster-connection-class.png images/NdbBlob-class.png images/NdbDictionary-classes.png images/NdbDictionary-Dictionary-class.png images/NdbDictionary-Column-class.png images/NdbDictionary-Object-class.png images/NdbDictionary-Object-Datafile-class.png images/NdbDictionary-Object-Event-class.png images/NdbDictionary-Object-Index-class.png images/NdbDictionary-Object-LogfileGroup-class.png images/NdbDictionary-Object-Table-class.png images/NdbDictionary-Object-Tablespace-class.png images/NdbDictionary-Object-Undofile-class.png images/NdbDictionary-AutoGrowSpecification-struct.png images/NdbEventOperation-class.png images/NdbOperation-subclasses.png images/NdbOperation-class.png images/NdbOperation-class.png images/NdbScanOperation-class.png images/NdbIndexScanOperation-class.png errors.xml images/NdbError-struct.png examples.xml 
+NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml getting-started.xml mgm-api.xml ndb-classes.xml images/Ndb-class.png images/Ndb-cluster-connection-class.png images/NdbBlob-class.png images/NdbDictionary-classes.png images/NdbDictionary-Dictionary-class.png images/NdbDictionary-Column-class.png images/NdbDictionary-Object-class.png images/NdbDictionary-Object-Datafile-class.png images/NdbDictionary-Object-Event-class.png images/NdbDictionary-Object-Index-class.png images/NdbDictionary-Object-LogfileGroup-class.png images/NdbDictionary-Object-Table-class.png images/NdbDictionary-Object-Tablespace-class.png images/NdbDictionary-Object-Undofile-class.png images/NdbDictionary-AutoGrowSpecification-struct.png images/NdbEventOperation-class.png images/NdbOperation-subclasses.png images/NdbOperation-class.png images/NdbOperation-class.png images/NdbScanOperation-class.png images/NdbIndexScanOperation-class.png images/NdbRecAttr-class.png errors.xml images/NdbError-struct!
 .png examples.xml 
 
 ndbapi-prepped.xml: $(NDBAPI_SRCS)
 

Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml	2006-07-02 06:46:28 UTC (rev 2587)
+++ trunk/ndbapi/ndb-classes.xml	2006-07-02 11:44:05 UTC (rev 2588)
@@ -27773,12 +27773,1374 @@
 
     <title>The <literal>NdbRecAttr</literal> Class</title>
 
-<!-- <abstract> -->
+    <abstract>
 
-    <para/>
+      <para>
+        The section describes the <literal>NdbRecAttr</literal> class
+        and its public methods.
+      </para>
 
-<!-- </abstract> -->
+    </abstract>
 
+    <formalpara>
+
+      <title>Description</title>
+
+      <para>
+        <literal>NdbRecAttr</literal> contains the value of an
+        attribute. An <literal>NdbRecAttr</literal> object is used to
+        store an attribute value after it has been retrieved the
+        <literal>NDB</literal> Cluster using the
+        <literal>NdbOperation::getValue()</literal>. This object is
+        allocated by the <literal>NDB</literal> API. A brief example is
+        shown here:
+
+<programlisting>
+MyRecAttr = MyOperation->getValue("ATTR2", NULL);
+
+if(MyRecAttr == NULL) goto error;
+ 
+if(MyTransaction->execute(Commit) == -1)
+  goto error;
+
+ndbout &lt;&lt; MyRecAttr->u_32_value();
+</programlisting>
+
+        For more examples, see
+        <xref linkend="example-synchronous-transactions"/>.
+      </para>
+
+    </formalpara>
+
+    <note>
+      <para>
+        An <literal>NdbRecAttr</literal> object is instantiated with its
+        value when <literal>NdbTransaction::execute()</literal> is
+        invoked. Prior to this, the value is undefined. (Use
+        <literal>NdbRecAttr::isNULL()</literal> to check whether the
+        value is defined.) This means that an
+        <literal>NdbRecAttr</literal> object has valid information only
+        between the times that
+        <literal>NdbTransaction::execute()</literal> and
+        <literal>Ndb::closeTransaction()</literal> are called. The value
+        of the null indicator is <literal>-1</literal> until
+        <literal>NdbTransaction::execute()</literal> method is invoked.
+      </para>
+    </note>
+
+    <formalpara>
+
+      <title>Public Methods</title>
+
+      <para>
+        <literal>NdbRecAttr</literal> has a number of methods for
+        retrieving values of various simple types directly from an
+        instance of this class. To obtain a reference to the value, use
+        <literal>NdbRecAttr::aRef()</literal>. The following table lists
+        all of the public methods of this class and the purpose or use
+        of each method:
+      </para>
+
+    </formalpara>
+
+    <informaltable>
+      <tgroup cols="2">
+        <colspec colwidth="35*"/>
+        <colspec colwidth="65*"/>
+        <thead>
+          <row>
+            <entry>Method</entry>
+            <entry>Purpose / Use</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry><literal>getColumn()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>getType()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>get_size_in_bytes()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>isNULL()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>int64_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>int32_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>short_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>char_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>u_64_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>U-32_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>u_short_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>u_char_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>float_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>double_value()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>aRef()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>clone()</literal></entry>
+            <entry></entry>
+          </row>
+          <row>
+            <entry><literal>~NdbRecAttr()</literal></entry>
+            <entry></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </informaltable>
+
+    <para>
+      For detailed descriptions, signatures, and examples of use for
+      each of these methods, see
+      <xref linkend="class-ndbrecattr-members"/>.
+    </para>
+
+    <formalpara>
+
+      <title>Public Types</title>
+
+      <para>
+        The <literal>NdbRecAttr</literal> class defines no public types.
+      </para>
+
+    </formalpara>
+
+    <formalpara>
+
+      <title>Class Diagram</title>
+
+      <para>
+        This diagram shows all the available methods of the
+        <literal>NdbRecAttr</literal> class:
+
+        <mediaobject>
+          <imageobject>
+            <imagedata fileref="images/NdbRecAttr-class.png" format="PNG"/>
+          </imageobject>
+          <textobject>
+            <phrase lang="en">Public methods of the
+            <literal>NdbRecAttr</literal> class.</phrase>
+          </textobject>
+        </mediaobject>
+      </para>
+
+    </formalpara>
+
+    <section id="class-ndbrecattr-members">
+
+      <title><literal>NdbRecAttr</literal> Class Members</title>
+
+      <abstract>
+
+        <para>
+          This section lists and describes the public methods of the
+          <literal>NdbRecAttr</literal> class.
+        </para>
+
+      </abstract>
+
+      <formalpara>
+
+        <title>Constructor and Destructor</title>
+
+        <para>
+          The <literal>NdbRecAttr</literal> class has no public
+          constructor; an instance of this object is created using
+          <literal>NdbTransaction::execute()</literal>. The destructor
+          method, which is public, is discussed in
+          <xref linkend="class-ndbrecattr-destructor"/>.
+        </para>
+
+      </formalpara>
+
+      <section id="class-ndbrecattr-getcolumn">
+
+        <title><literal>NdbRecAttr::getColumn()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method is used to obtain the column to which the
+            attribute belongs.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+const NdbDictionary::Column* getColumn
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            A pointer to a <literal>Column</literal> object. See
+            <xref linkend="class-column"/>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbrecattr-gettype">
+
+        <title><literal>NdbRecAttr::getType()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method is used to obtain the column's datatype.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+NdbDictionary::Column::Type getType
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            An <literal>NdbDictionary::Column::Type</literal> value. See
+            <xref linkend="class-column-type"/> for more information,
+            including permitted values.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbrecattr-get-size-in-bytes">
+
+        <title><literal>NdbRecAttr::get_size_in_bytes()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            You can use this method to obtain the size of an attribute
+            (element).
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+Uint32 get_size_in_bytes
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            The attribute size in bytes, as an unsigned 32-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbrecattr-isnull">
+
+        <title><literal>NdbRecAttr::isNULL()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method checks whether an attribute value is
+            <literal>NULL</literal>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+int isNULL
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            One of the following 3 values:
+
+            <itemizedlist>
+
+              <listitem>
+                <para>
+                  <literal>-1</literal>: The attribute value is not
+                  defined, either due to an error, or because
+                  <literal>NdbTransaction::execute()</literal> has not
+                  yet been used.
+                </para>
+              </listitem>
+
+              <listitem>
+                <para>
+                  <literal>0</literal>: The attribute value is defined,
+                  but is not <literal>NULL</literal>.
+                </para>
+              </listitem>
+
+              <listitem>
+                <para>
+                  <literal>1</literal>: The attribute value is defined
+                  and is <literal>NULL</literal>.
+                </para>
+              </listitem>
+
+            </itemizedlist>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-int64-value">
+
+        <title><literal>NdbRecAttr::in64_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as a
+            64-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+Int64 int64_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            A 64-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-int32-value">
+
+        <title><literal>NdbRecAttr::int32_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as a
+            32-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+Int32 int32_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            A 32-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-short-value">
+
+        <title><literal>NdbRecAttr::short_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as a
+            16-bit integer (short).
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+short short_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            A 16-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-char-value">
+
+        <title><literal>NdbRecAttr::char_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as a
+            <literal>char</literal>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+char char_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            A <literal>char</literal> value.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-u-64-value">
+
+        <title><literal>NdbRecAttr::u_64_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as an
+            unsigned 64-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+Uint64 u_64_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            An unsigned 64-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-u-32-value">
+
+        <title><literal>NdbRecAttr::in64_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as an
+            unsigned 32-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+Uint32 u_32_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            An unsigned 32-bit integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-u-short-value">
+
+        <title><literal>NdbRecAttr::u_short_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as an
+            unsigned 16-bit (short) integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+Uint16 u_short_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            An unsigned short (16-bit) integer.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-u-char-value">
+
+        <title><literal>NdbRecAttr::u_char_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as an
+            unsigned <literal>char</literal>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+Uint8 u_char_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            An unsigned 8-bit <literal>char</literal> value.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-float-value">
+
+        <title><literal>NdbRecAttr::float_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as a
+            float.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+float float_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            A float.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbreccattr-double-value">
+
+        <title><literal>NdbRecAttr::double_value()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method gets the value stored in an
+            <literal>NdbRecAttr</literal> object, and returns it as a
+            double.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+double double_value
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            A double.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbrecattr-aref">
+
+        <title><literal>NdbRecAttr::aRef()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method is used to obtain a reference to an attribute
+            value, as a <literal>char</literal> pointer. This pointer is
+            aligned appropriately for the datatype. The memory is
+            released by the <literal>NDB</literal> API when
+            <literal>NdbTransaction::closeTransaction()</literal> is
+            executed on the transaction which read the value.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+char* aRef
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            A pointer to the attribute value. Because this pointer is
+            constant, this method can be called anytime after
+            <literal>NdbOperation::getValue()</literal> has been called.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbrecattr-clone">
+
+        <title><literal>NdbRecAttr::clone()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This method creates a deep copy of an
+            <literal>NdbRecAttr</literal> object.
+          </para>
+
+        </formalpara>
+
+        <note>
+          <para>
+            The copy created by this method should be deleted by the
+            application when no longer needed.
+          </para>
+        </note>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+NdbRecAttr* clone
+    (
+      void
+    ) const
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            An <literal>NdbRecAttr</literal> object. This is a complete
+            copy of the original, including all data.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="class-ndbrecattr-destructor">
+
+        <title><literal>~NdbRecAttr()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            The <literal>NdbRecAttr</literal> class destructor method.
+          </para>
+
+        </formalpara>
+
+        <important>
+          <para>
+            You should delete only copies of
+            <literal>NdbRecAttr</literal> objects that were created in
+            your application using the <literal>clone()</literal>
+            method. See <xref linkend="class-ndbrecattr-clone"/>.
+          </para>
+        </important>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+~NdbRecAttr
+    (
+      void
+    )
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+    </section>
+
   </section>
 
   <section id="class-ndbscanfilter">
@@ -27803,54 +29165,69 @@
 
 <!-- </abstract> -->
 
-    <section id="class-ndbtransaction-execute">
+    <section id="class-ndbtransaction-members">
 
-      <title>NdbTransaction::execute()</title>
+      <title><literal>NdbTransaction</literal> Class Members</title>
 
-      <para>
-        Placeholder.
-      </para>
+      <abstract>
 
-    </section>
+        <para>
+          This section lists and describes the public methods of the
+          <literal>NdbTransaction</literal> class.
+        </para>
 
-    <section id="class-ndbtransaction-getndboperation">
+      </abstract>
 
-      <title>NdbTransaction::getNdbOperation()</title>
+      <section id="class-ndbtransaction-execute">
 
-      <para>
-        Placeholder.
-      </para>
+        <title>NdbTransaction::execute()</title>
 
-    </section>
+        <para>
+          Placeholder.
+        </para>
 
-    <section id="class-ndbtransaction-getndbindexoperation">
+      </section>
 
-      <title>NdbTransaction::getNdbIndexOperation()</title>
+      <section id="class-ndbtransaction-getndboperation">
 
-      <para>
-        Placeholder.
-      </para>
+        <title>NdbTransaction::getNdbOperation()</title>
 
-    </section>
+        <para>
+          Placeholder.
+        </para>
 
-    <section id="class-ndbtransaction-getndbscanoperation">
+      </section>
 
-      <title>NdbTransaction::getNdbscanOperation()</title>
+      <section id="class-ndbtransaction-getndbindexoperation">
 
-      <para>
-        Placeholder.
-      </para>
+        <title>NdbTransaction::getNdbIndexOperation()</title>
 
-    </section>
+        <para>
+          Placeholder.
+        </para>
 
-    <section id="class-ndbtransaction-getndbindexscanoperation">
+      </section>
 
-      <title>NdbTransaction::getNdbIndexScanOperation()</title>
+      <section id="class-ndbtransaction-getndbscanoperation">
 
-      <para>
-        Placeholder.
-      </para>
+        <title>NdbTransaction::getNdbscanOperation()</title>
 
+        <para>
+          Placeholder.
+        </para>
+
+      </section>
+
+      <section id="class-ndbtransaction-getndbindexscanoperation">
+
+        <title>NdbTransaction::getNdbIndexScanOperation()</title>
+
+        <para>
+          Placeholder.
+        </para>
+
+      </section>
+
     </section>
 
   </section>

Thread
svn commit - mysqldoc@docsrva: r2588 - trunk/ndbapijon2 Jul