From 4b8d14f85247b9ed340c583befe9df42a63027fb Mon Sep 17 00:00:00 2001
From: Hartmut Holzgraefe <hholzgra@php.net>
Date: Thu, 7 Mar 2002 00:27:09 +0000
Subject: [PATCH] initial checkin

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@72206 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/mcve.xml | 1247 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 1247 insertions(+)
 create mode 100644 functions/mcve.xml

diff --git a/functions/mcve.xml b/functions/mcve.xml
new file mode 100644
index 0000000000..fae4a20e21
--- /dev/null
+++ b/functions/mcve.xml
@@ -0,0 +1,1247 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+ <reference id="ref.mcve">
+  <title>MCVE functions</title>
+  <titleabbrev>MCVE functions</titleabbrev>
+
+  <partintro>
+   &warn.experimental;
+   <para>
+   </para>
+  </partintro>
+
+
+  <refentry id="function.mcve-initengine">
+   <refnamediv>
+    <refname>mcve_initengine</refname>
+    <refpurpose>Ready the client for IP/SSL Communication </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_initengine</methodname>
+     <methodparam><type>string</type><parameter>location</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-initconn">
+   <refnamediv>
+    <refname>mcve_initconn</refname>
+    <refpurpose>Create and initialize an MCVE_CONN structure </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>resource</type><methodname>mcve_initconn</methodname>
+     <void/>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-deleteresponse">
+   <refnamediv>
+    <refname>mcve_deleteresponse</refname>
+    <refpurpose>Delete specified transaction from MCVE_CONN structure </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>bool</type><methodname>mcve_deleteresponse</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-destroyconn">
+   <refnamediv>
+    <refname>mcve_destroyconn</refname>
+    <refpurpose>Destroy the connection and MCVE_CONN structure </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>void</type><methodname>mcve_destroyconn</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-setdropfile">
+   <refnamediv>
+    <refname>mcve_setdropfile</refname>
+    <refpurpose>Set the connection method to Drop-File </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_setdropfile</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>directory</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-setip">
+   <refnamediv>
+    <refname>mcve_setip</refname>
+    <refpurpose>Set the connection method to IP </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_setip</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>host</parameter></methodparam>
+     <methodparam><type>int</type><parameter>port</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-setssl">
+   <refnamediv>
+    <refname>mcve_setssl</refname>
+    <refpurpose>Set the connection method to SSL </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_setssl</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>host</parameter></methodparam>
+     <methodparam><type>int</type><parameter>port</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-settimeout">
+   <refnamediv>
+    <refname>mcve_settimeout</refname>
+    <refpurpose>Set maximum transaction time (per tran</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_settimeout</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>seconds</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-connect">
+   <refnamediv>
+    <refname>mcve_connect</refname>
+    <refpurpose>Establish the connection to MCVE </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_connect</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transactionssent">
+   <refnamediv>
+    <refname>mcve_transactionssent</refname>
+    <refpurpose>Check to see if outgoing buffer is clear </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_transactionssent</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-returnstatus">
+   <refnamediv>
+    <refname>mcve_returnstatus</refname>
+    <refpurpose>Check to see if the transaction was successful </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_returnstatus</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-returncode">
+   <refnamediv>
+    <refname>mcve_returncode</refname>
+    <refpurpose>Grab the exact return code from the transaction </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_returncode</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transactionitem">
+   <refnamediv>
+    <refname>mcve_transactionitem</refname>
+    <refpurpose>Get the ITEM number in the associated batch for this transaction </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_transactionitem</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transactionavs">
+   <refnamediv>
+    <refname>mcve_transactionavs</refname>
+    <refpurpose>Get the Address Verification return status </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_transactionavs</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transactioncv">
+   <refnamediv>
+    <refname>mcve_transactioncv</refname>
+    <refpurpose>Get the CVC2/CVV2/CID return status </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_transactioncv</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transactionbatch">
+   <refnamediv>
+    <refname>mcve_transactionbatch</refname>
+    <refpurpose>Get the batch number associated with the transaction </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_transactionbatch</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transactionid">
+   <refnamediv>
+    <refname>mcve_transactionid</refname>
+    <refpurpose>Get the unique system id for the transacti</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_transactionid</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transactionauth">
+   <refnamediv>
+    <refname>mcve_transactionauth</refname>
+    <refpurpose>Get the authorization number returned for the transaction (alpha-numeric) </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>mcve_transactionauth</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transactiontext">
+   <refnamediv>
+    <refname>mcve_transactiontext</refname>
+    <refpurpose>Get verbiage (text) return from MCVE or processing institution </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>mcve_transactiontext</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-monitor">
+   <refnamediv>
+    <refname>mcve_monitor</refname>
+    <refpurpose>Perform communication with MCVE (send/receive data)   Non-blocking </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_monitor</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-transinqueue">
+   <refnamediv>
+    <refname>mcve_transinqueue</refname>
+    <refpurpose>Number of transactions in client-queue </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_transinqueue</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-checkstatus">
+   <refnamediv>
+    <refname>mcve_checkstatus</refname>
+    <refpurpose>Check to see if a transaction has completed </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_checkstatus</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-completeauthorizations">
+   <refnamediv>
+    <refname>mcve_completeauthorizations</refname>
+    <refpurpose>&array) Number of complete authorizations in queue, returning an array of their identifiers </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_completeauthorizations</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter></parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-sale">
+   <refnamediv>
+    <refname>mcve_sale</refname>
+    <refpurpose>Send a SALE to MCVE </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_sale</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>trackdata</parameter></methodparam>
+     <methodparam><type>string</type><parameter>account</parameter></methodparam>
+     <methodparam><type>string</type><parameter>expdate</parameter></methodparam>
+     <methodparam><type>float</type><parameter>amount</parameter></methodparam>
+     <methodparam><type>string</type><parameter>street</parameter></methodparam>
+     <methodparam><type>string</type><parameter>zip</parameter></methodparam>
+     <methodparam><type>string</type><parameter>cv</parameter></methodparam>
+     <methodparam><type>string</type><parameter>comments</parameter></methodparam>
+     <methodparam><type>string</type><parameter>clerkid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>stationid</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-preauth">
+   <refnamediv>
+    <refname>mcve_preauth</refname>
+    <refpurpose>string clerkid, string stationid, int ptrannum) Send a PREAUTHORIZATION to MCVE </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_preauth</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>trackdata</parameter></methodparam>
+     <methodparam><type>string</type><parameter>account</parameter></methodparam>
+     <methodparam><type>string</type><parameter>expdate</parameter></methodparam>
+     <methodparam><type>float</type><parameter>amount</parameter></methodparam>
+     <methodparam><type>string</type><parameter>street</parameter></methodparam>
+     <methodparam><type>string</type><parameter>zip</parameter></methodparam>
+     <methodparam><type>string</type><parameter>cv</parameter></methodparam>
+     <methodparam><type>string</type><parameter>comments</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-override">
+   <refnamediv>
+    <refname>mcve_override</refname>
+    <refpurpose>Send an OVERRIDE to MCVE </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_override</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>trackdata</parameter></methodparam>
+     <methodparam><type>string</type><parameter>account</parameter></methodparam>
+     <methodparam><type>string</type><parameter>expdate</parameter></methodparam>
+     <methodparam><type>float</type><parameter>amount</parameter></methodparam>
+     <methodparam><type>string</type><parameter>street</parameter></methodparam>
+     <methodparam><type>string</type><parameter>zip</parameter></methodparam>
+     <methodparam><type>string</type><parameter>cv</parameter></methodparam>
+     <methodparam><type>string</type><parameter>comments</parameter></methodparam>
+     <methodparam><type>string</type><parameter>clerkid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>stationid</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-void">
+   <refnamediv>
+    <refname>mcve_void</refname>
+    <refpurpose>VOID a transaction in the settlement queue </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_void</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>int</type><parameter>sid</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-preauthcompletion">
+   <refnamediv>
+    <refname>mcve_preauthcompletion</refname>
+    <refpurpose>Complete a PREAUTHORIZATION... Ready it for settlement </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_preauthcompletion</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>float</type><parameter>finalamount</parameter></methodparam>
+     <methodparam><type>int</type><parameter>sid</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-force">
+   <refnamediv>
+    <refname>mcve_force</refname>
+    <refpurpose>resiurce conn, string username, string password, string trackdata, string account, string expdate, float amount, string authcode, string comments, string clerkid, string stationid, int ptrannum) Send a FORCE to MCVE.  (typically, a phone-authorization) </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_force</methodname>
+     <void/>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-return">
+   <refnamediv>
+    <refname>mcve_return</refname>
+    <refpurpose>Issue a RETURN or CREDIT to MCVE </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_return</methodname>
+     <methodparam><type>int</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>trackdata</parameter></methodparam>
+     <methodparam><type>string</type><parameter>account</parameter></methodparam>
+     <methodparam><type>string</type><parameter>expdate</parameter></methodparam>
+     <methodparam><type>float</type><parameter>amount</parameter></methodparam>
+     <methodparam><type>string</type><parameter>comments</parameter></methodparam>
+     <methodparam><type>string</type><parameter>clerkid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>stationid</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-settle">
+   <refnamediv>
+    <refname>mcve_settle</refname>
+    <refpurpose>Issue a settlement command to do a batch deposit </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_settle</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>batch</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-ub">
+   <refnamediv>
+    <refname>mcve_ub</refname>
+    <refpurpose>Get a list of all Unsettled batches </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_ub</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-qc">
+   <refnamediv>
+    <refname>mcve_qc</refname>
+    <refpurpose>Audit MCVE for a list of transactions in the outgoing queue </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_qc</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>clerkid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>stationid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>comments</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-gut">
+   <refnamediv>
+    <refname>mcve_gut</refname>
+    <refpurpose>Audit MCVE for Unsettled Transactions </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_gut</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>int</type><parameter>type</parameter></methodparam>
+     <methodparam><type>string</type><parameter>account</parameter></methodparam>
+     <methodparam><type>string</type><parameter>clerkid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>stationid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>comments</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+     <methodparam><type>string</type><parameter>startdate</parameter></methodparam>
+     <methodparam><type>string</type><parameter>enddate</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-gl">
+   <refnamediv>
+    <refname>mcve_gl</refname>
+    <refpurpose>Audit MCVE for settled transactions </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_gl</methodname>
+     <methodparam><type>int</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>int</type><parameter>type</parameter></methodparam>
+     <methodparam><type>string</type><parameter>account</parameter></methodparam>
+     <methodparam><type>string</type><parameter>batch</parameter></methodparam>
+     <methodparam><type>string</type><parameter>clerkid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>stationid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>comments</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+     <methodparam><type>string</type><parameter>startdate</parameter></methodparam>
+     <methodparam><type>string</type><parameter>enddate</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-gft">
+   <refnamediv>
+    <refname>mcve_gft</refname>
+    <refpurpose>Audit MCVE for Failed transactio</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_gft</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+     <methodparam><type>int</type><parameter>type</parameter></methodparam>
+     <methodparam><type>string</type><parameter>account</parameter></methodparam>
+     <methodparam><type>string</type><parameter>clerkid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>stationid</parameter></methodparam>
+     <methodparam><type>string</type><parameter>comments</parameter></methodparam>
+     <methodparam><type>int</type><parameter>ptrannum</parameter></methodparam>
+     <methodparam><type>string</type><parameter>startdate</parameter></methodparam>
+     <methodparam><type>string</type><parameter>enddate</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-chkpwd">
+   <refnamediv>
+    <refname>mcve_chkpwd</refname>
+    <refpurpose>Verify Password </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_chkpwd</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-bt">
+   <refnamediv>
+    <refname>mcve_bt</refname>
+    <refpurpose>Get unsettled batch totals </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_bt</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+     <methodparam><type>string</type><parameter>password</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-getcell">
+   <refnamediv>
+    <refname>mcve_getcell</refname>
+    <refpurpose>Get a specific cell from a comma delimited response by column name </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>mcve_getcell</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+     <methodparam><type>string</type><parameter>column</parameter></methodparam>
+     <methodparam><type>int</type><parameter>row</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-getcellbynum">
+   <refnamediv>
+    <refname>mcve_getcellbynum</refname>
+    <refpurpose>Get a specific cell from a comma delimited response by column number </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>mcve_getcellbynum</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+     <methodparam><type>int</type><parameter>column</parameter></methodparam>
+     <methodparam><type>int</type><parameter>row</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-numcolumns">
+   <refnamediv>
+    <refname>mcve_numcolumns</refname>
+    <refpurpose>Number of columns returned in a comma delimited response </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_numcolumns</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-numrows">
+   <refnamediv>
+    <refname>mcve_numrows</refname>
+    <refpurpose>Number of rows returned in a comma delimited response </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_numrows</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-iscommadelimited">
+   <refnamediv>
+    <refname>mcve_iscommadelimited</refname>
+    <refpurpose>Checks to see if response is comma delimited </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_iscommadelimited</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-parsecommadelimited">
+   <refnamediv>
+    <refname>mcve_parsecommadelimited</refname>
+    <refpurpose>Parse the comma delimited response so mcve_getcell, etc will work </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_parsecommadelimited</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-getcommadelimited">
+   <refnamediv>
+    <refname>mcve_getcommadelimited</refname>
+    <refpurpose>Get the RAW comma delimited data returned from MCVE </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>mcve_getcommadelimited</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-getheader">
+   <refnamediv>
+    <refname>mcve_getheader</refname>
+    <refpurpose>Get the name of the column in a comma-delimited response </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>mcve_getheader</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>int</type><parameter>identifier</parameter></methodparam>
+     <methodparam><type>int</type><parameter>column_num</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-destroyengine">
+   <refnamediv>
+    <refname>mcve_destroyengine</refname>
+    <refpurpose>Free memory associated with IP/SSL connectivity </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>void</type><methodname>mcve_destroyengine</methodname>
+     <void/>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-chngpwd">
+   <refnamediv>
+    <refname>mcve_chngpwd</refname>
+    <refpurpose>Change the system administrator's password </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_chngpwd</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>admin_password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>new_password</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-listusers">
+   <refnamediv>
+    <refname>mcve_listusers</refname>
+    <refpurpose>List all users on MCVE system </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_listusers</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>admin_password</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-enableuser">
+   <refnamediv>
+    <refname>mcve_enableuser</refname>
+    <refpurpose>Enable an inactive MCVE user account </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_enableuser</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>admin_password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-disableuser">
+   <refnamediv>
+    <refname>mcve_disableuser</refname>
+    <refpurpose>Disable an active MCVE user account </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_disableuser</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>admin_password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-deluser">
+   <refnamediv>
+    <refname>mcve_deluser</refname>
+    <refpurpose>Delete an MCVE user account </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_deluser</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>admin_password</parameter></methodparam>
+     <methodparam><type>string</type><parameter>username</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-liststats">
+   <refnamediv>
+    <refname>mcve_liststats</refname>
+    <refpurpose>List statistics for all users on MCVE system </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_liststats</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>admin_password</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-initusersetup">
+   <refnamediv>
+    <refname>mcve_initusersetup</refname>
+    <refpurpose>Initialize structure to store user data </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>resource</type><methodname>mcve_initusersetup</methodname>
+     <void/>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-deleteusersetup">
+   <refnamediv>
+    <refname>mcve_deleteusersetup</refname>
+    <refpurpose>Deallocate data associated with usersetup structure </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>void</type><methodname>mcve_deleteusersetup</methodname>
+     <methodparam><type>resource</type><parameter>usersetup</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-adduserarg">
+   <refnamediv>
+    <refname>mcve_adduserarg</refname>
+    <refpurpose>Add a value to user configuration structure </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_adduserarg</methodname>
+     <methodparam><type>resource</type><parameter>usersetup</parameter></methodparam>
+     <methodparam><type>int</type><parameter>argtype</parameter></methodparam>
+     <methodparam><type>string</type><parameter>argval</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-getuserarg">
+   <refnamediv>
+    <refname>mcve_getuserarg</refname>
+    <refpurpose>Grab a value from usersetup structure </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>string</type><methodname>mcve_getuserarg</methodname>
+     <methodparam><type>resource</type><parameter>usersetup</parameter></methodparam>
+     <methodparam><type>int</type><parameter>argtype</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-adduser">
+   <refnamediv>
+    <refname>mcve_adduser</refname>
+    <refpurpose>Add an MCVE user using usersetup structure </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_adduser</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>admin_password</parameter></methodparam>
+     <methodparam><type>int</type><parameter>usersetup</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id="function.mcve-edituser">
+   <refnamediv>
+    <refname>mcve_edituser</refname>
+    <refpurpose>Edit MCVE user using usersetup structure</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>mcve_edituser</methodname>
+     <methodparam><type>resource</type><parameter>conn</parameter></methodparam>
+     <methodparam><type>string</type><parameter>admin_password</parameter></methodparam>
+     <methodparam><type>int</type><parameter>usersetup</parameter></methodparam>
+    </methodsynopsis>
+     &warn.experimental.func;
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+ </reference>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+