Author: jstephens
Date: 2008-04-13 13:58:18 +0200 (Sun, 13 Apr 2008)
New Revision: 10467
Log:
Documented missing NdbScanFilter methods:
istrue()
isfalse()
getNdbError()
getNdbOperation()
Fixes Docs Bug #36016.
Modified:
trunk/ndbapi/class-ndbscanfilter.xml
Modified: trunk/ndbapi/class-ndbscanfilter.xml
===================================================================
--- trunk/ndbapi/class-ndbscanfilter.xml 2008-04-13 10:37:07 UTC (rev 10466)
+++ trunk/ndbapi/class-ndbscanfilter.xml 2008-04-13 11:58:18 UTC (rev 10467)
Changed blocks: 4, Lines Added: 320, Lines Deleted: 13; 7616 bytes
@@ -102,20 +102,14 @@
<entry><literal>end()</literal></entry>
<entry>Ends a compound</entry>
</row>
-<!--
-
- <remark role="note">
- [js] Commenting these out until they can be documented.
- </remark>
<row>
<entry><literal>istrue()</literal></entry>
- <entry></entry>
+ <entry>Defines a term in a compound as <literal>TRUE</literal></entry>
</row>
<row>
<entry><literal>isfalse()</literal></entry>
- <entry></entry>
+ <entry>Defines a term in a compound as <literal>FALSE</literal></entry>
</row>
--->
<row>
<entry><literal>cmp()</literal></entry>
<entry>Compares a column value with an arbitrary value</entry>
@@ -152,6 +146,14 @@
<entry><literal>isnotnull()</literal></entry>
<entry>Tests whether a column value is not <literal>NULL</literal></entry>
</row>
+ <row>
+ <entry><literal>getNdbError()</literal></entry>
+ <entry>Provides access to error information</entry>
+ </row>
+ <row>
+ <entry><literal>getNdbOperation()</literal></entry>
+ <entry>Gets the associated <literal>NdbOperation</literal></entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
@@ -636,6 +638,156 @@
</section>
+ <section id="class-ndbscanfilter-istrue">
+
+ <title><literal>NdbScanFilter::istrue()</literal></title>
+
+ <indexterm>
+ <primary>NdbScanFilter::istrue()</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>istrue() (method of NdbScanFilter)</primary>
+ </indexterm>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Defines a term of the current group as
+ <literal>TRUE</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+int istrue
+ (
+ void
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <literal>0</literal> on success, <literal>-1</literal> on
+ failure.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndbscanfilter-isfalse">
+
+ <title><literal>NdbScanFilter::isfalse()</literal></title>
+
+ <indexterm>
+ <primary>NdbScanFilter::isfalse()</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>isfalse() (method of NdbScanFilter)</primary>
+ </indexterm>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Defines a term of the current group as
+ <literal>FALSE</literal>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+int isfalse
+ (
+ void
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ <literal>0</literal> on success, <literal>-1</literal> on
+ failure.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
<section id="class-ndbscanfilter-cmp">
<title><literal>NdbScanFilter::cmp()</literal></title>
@@ -1593,21 +1745,176 @@
</formalpara>
<!--
- <formalpara>
+ <formalpara>
- <title>Example</title>
+ <title>Example</title>
- <para>
+ <para>
<programlisting>
[<emphasis>To be supplied...</emphasis>]
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
-->
</section>
+ <section id="class-ndbscanfilter-getndberror">
+
+ <title><literal>NdbScanFilter::getNdbError()</literal></title>
+
+ <indexterm>
+ <primary>NdbScanFilter::getNdbError()</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>getNdbError() (method of NdbScanFilter)</primary>
+ </indexterm>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ Because errors encountered when building an NdbScanFilter do
+ not propagate to any involved <literal>NdbOperation</literal>
+ object, it is necessary to use this method to access error
+ information.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+const NdbError& getNdbError
+ (
+ void
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A reference to an <literal>NdbError</literal>. See
+ <xref linkend="struct-ndberror"/>, for more information.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
+ <section id="class-ndbscanfilter-getndboperation">
+
+ <title><literal>NdbScanFilter::getNdbOperation()</literal></title>
+
+ <indexterm>
+ <primary>NdbScanFilter::getNdbOperation()</primary>
+ </indexterm>
+
+ <indexterm>
+ <primary>getNdbOperation() (method of NdbScanFilter)</primary>
+ </indexterm>
+
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ If the <literal>NdbScanFilter</literal> was constructed with
+ an <literal>NdbOperation</literal>, this method can be used to
+ obtain a pointer to that <literal>NdbOperation</literal>
+ object.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
+<programlisting>
+NdbOperation* getNdbOperation
+ (
+ void
+ )
+</programlisting>
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Parameters</title>
+
+ <para>
+ <emphasis>None</emphasis>.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ A pointer to the <literal>NdbOperation</literal> associated
+ with this <literal>NdbScanFilter</literal>, if there is one.
+ Otherwise, <literal>NULL</literal>.
+ </para>
+
+ </formalpara>
+
+<!--
+ <formalpara>
+
+ <title>Example</title>
+
+ <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+ </para>
+
+ </formalpara>
+-->
+
+ </section>
+
</section>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r10467 - trunk/ndbapi | jon | 13 Apr |
