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

[jon]

Author: jstephens
Date: 2006-06-27 11:59:02 +0200 (Tue, 27 Jun 2006)
New Revision: 2527

Log:
MGM API management server creation & destruction functions.

Modified:
   trunk/ndbapi/mgm-api.xml

Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml	2006-06-27 09:38:07 UTC (rev 2526)
+++ trunk/ndbapi/mgm-api.xml	2006-06-27 09:59:02 UTC (rev 2527)
@@ -1131,14 +1131,145 @@
 
     <section id="mgm-api-functions-management-server-handles">
 
-      <title>Creating &amp; Destroying Management Server Handles</title>
+      <title>Management Server Handles</title>
 
-<!-- <abstract> -->
+      <abstract>
 
-      <para></para>
+        <para>
+          This section contains information about the MGM API functions
+          used to create and destroy management server handles.
+        </para>
 
-<!-- </abstract> -->
+      </abstract>
 
+      <section id="mgm-api-ndb-mgm-create-handle">
+
+        <title><literal>ndb_mgm_create_handle()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This function is used to create a handle to a management
+            server.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+NdbMgmHandle ndb_mgm_create_handle
+    (
+      void
+    )
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            An <literal>NdbMgmHandle</literal>.
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+
+      </section>
+
+      <section id="mgm-api-">
+
+        <title><literal>()</literal></title>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            This function destroys a management server handle
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+void ndb_mgm_destroy_handle
+    (
+      NdbMgmHandle* <replaceable>handle</replaceable>
+    )
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            A pointer to the <literal>NdbMgmHandle</literal> to be
+            destroyed.
+          </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 id="mgm-api-functions-management-server-connections">