<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libofx-0.6.2/inc/libofx.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center>
<hr><h1>libofx.h File Reference</h1>Main header file containing the LibOfx API.
<a href="#_details">More...</a>
<p>
<p>
<a href="libofx-0_86_82_2inc_2libofx_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structOfxAccountData.html">OfxAccountData</a></td></tr>
<tr><td> </td><td><font size=-1><em>An abstraction of an account.</em> <a href="structOfxAccountData.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structOfxCurrency.html">OfxCurrency</a></td></tr>
<tr><td> </td><td><font size=-1><em>NOT YET SUPPORTED.</em> <a href="structOfxCurrency.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structOfxSecurityData.html">OfxSecurityData</a></td></tr>
<tr><td> </td><td><font size=-1><em>An abstraction of a security, such as a stock, mutual fund, etc.</em> <a href="structOfxSecurityData.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structOfxStatementData.html">OfxStatementData</a></td></tr>
<tr><td> </td><td><font size=-1><em>An abstraction of an account statement.</em> <a href="structOfxStatementData.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structOfxStatusData.html">OfxStatusData</a></td></tr>
<tr><td> </td><td><font size=-1><em>An abstraction of an OFX STATUS element.</em> <a href="structOfxStatusData.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structOfxTransactionData.html">OfxTransactionData</a></td></tr>
<tr><td> </td><td><font size=-1><em>An abstraction of a transaction in an account.</em> <a href="structOfxTransactionData.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="libofx-0.6.2/inc/libofx.h::CFCT"></a>
#define </td><td valign=bottom><b>CFCT</b></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="libofx-0.6.2/inc/libofx.h::true"></a>
#define </td><td valign=bottom><b>true</b> 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="libofx-0.6.2/inc/libofx.h::false"></a>
#define </td><td valign=bottom><b>false</b> 0</td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="libofx-0.6.2/inc/libofx.h::OFX_ELEMENT_NAME_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_ELEMENT_NAME_LENGTH</b> 100</td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="libofx-0.6.2/inc/libofx.h::OFX_SVRTID2_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_SVRTID2_LENGTH</b> 36 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="libofx-0.6.2/inc/libofx.h::OFX_CHECK_NUMBER_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_CHECK_NUMBER_LENGTH</b> 12 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="libofx-0.6.2/inc/libofx.h::OFX_REFERENCE_NUMBER_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_REFERENCE_NUMBER_LENGTH</b> 32 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="libofx-0.6.2/inc/libofx.h::OFX_FITID_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_FITID_LENGTH</b> 255 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="libofx-0.6.2/inc/libofx.h::OFX_TOKEN2_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_TOKEN2_LENGTH</b> 36 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="libofx-0.6.2/inc/libofx.h::OFX_MEMO2_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_MEMO2_LENGTH</b> 390 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a10" doxytag="libofx-0.6.2/inc/libofx.h::OFX_BALANCE_NAME_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_BALANCE_NAME_LENGTH</b> 32 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a11" doxytag="libofx-0.6.2/inc/libofx.h::OFX_BALANCE_DESCRIPTION_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_BALANCE_DESCRIPTION_LENGTH</b> 80 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a12" doxytag="libofx-0.6.2/inc/libofx.h::OFX_CURRENCY_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_CURRENCY_LENGTH</b> 3 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a13" doxytag="libofx-0.6.2/inc/libofx.h::OFX_BANKID_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_BANKID_LENGTH</b> 9</td></tr>
<tr><td nowrap align=right valign=top><a name="a14" doxytag="libofx-0.6.2/inc/libofx.h::OFX_BRANCHID_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_BRANCHID_LENGTH</b> 22 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a15" doxytag="libofx-0.6.2/inc/libofx.h::OFX_ACCTID_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_ACCTID_LENGTH</b> 22 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a16" doxytag="libofx-0.6.2/inc/libofx.h::OFX_ACCTKEY_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_ACCTKEY_LENGTH</b> 22 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a17" doxytag="libofx-0.6.2/inc/libofx.h::OFX_BROKERID_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_BROKERID_LENGTH</b> 22 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a18" doxytag="libofx-0.6.2/inc/libofx.h::OFX_ACCOUNT_ID_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_ACCOUNT_ID_LENGTH</b> OFX_BANKID_LENGTH + OFX_BRANCHID_LENGTH + OFX_ACCTID_LENGTH + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a19" doxytag="libofx-0.6.2/inc/libofx.h::OFX_ACCOUNT_NAME_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_ACCOUNT_NAME_LENGTH</b> 255</td></tr>
<tr><td nowrap align=right valign=top><a name="a20" doxytag="libofx-0.6.2/inc/libofx.h::OFX_MARKETING_INFO_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_MARKETING_INFO_LENGTH</b> 360 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a21" doxytag="libofx-0.6.2/inc/libofx.h::OFX_TRANSACTION_NAME_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_TRANSACTION_NAME_LENGTH</b> 32 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a22" doxytag="libofx-0.6.2/inc/libofx.h::OFX_UNIQUE_ID_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_UNIQUE_ID_LENGTH</b> 32 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a23" doxytag="libofx-0.6.2/inc/libofx.h::OFX_UNIQUE_ID_TYPE_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_UNIQUE_ID_TYPE_LENGTH</b> 10 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a24" doxytag="libofx-0.6.2/inc/libofx.h::OFX_SECNAME_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_SECNAME_LENGTH</b> 32 + 1</td></tr>
<tr><td nowrap align=right valign=top><a name="a25" doxytag="libofx-0.6.2/inc/libofx.h::OFX_TICKER_LENGTH"></a>
#define </td><td valign=bottom><b>OFX_TICKER_LENGTH</b> 32 + 1</td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>CFCT int </td><td valign=bottom><a class="el" href="libofx-0_86_82_2inc_2libofx_8h.html#a26">ofx_proc_file</a> (int argc, char *argv[])</td></tr>
<tr><td> </td><td><font size=-1><em>ofx_proc_file is the entry point of the library.</em> <a href="#a26">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>CFCT int </td><td valign=bottom><a class="el" href="libofx-0_86_82_2inc_2libofx_8h.html#a27">ofx_proc_status_cb</a> (const struct <a class="el" href="structOfxStatusData.html">OfxStatusData</a> data)</td></tr>
<tr><td> </td><td><font size=-1><em>The callback function for the <a class="el" href="structOfxStatusData.html">OfxStatusData</a> stucture.</em> <a href="#a27">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>CFCT int </td><td valign=bottom><a class="el" href="libofx-0_86_82_2inc_2libofx_8h.html#a28">ofx_proc_account_cb</a> (const struct <a class="el" href="structOfxAccountData.html">OfxAccountData</a> data)</td></tr>
<tr><td> </td><td><font size=-1><em>The callback function for the <a class="el" href="structOfxAccountData.html">OfxAccountData</a> stucture.</em> <a href="#a28">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>CFCT int </td><td valign=bottom><a class="el" href="libofx-0_86_82_2inc_2libofx_8h.html#a29">ofx_proc_security_cb</a> (const struct <a class="el" href="structOfxSecurityData.html">OfxSecurityData</a> data)</td></tr>
<tr><td> </td><td><font size=-1><em>The callback function for the <a class="el" href="structOfxSecurityData.html">OfxSecurityData</a> stucture.</em> <a href="#a29">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>CFCT int </td><td valign=bottom><a class="el" href="libofx-0_86_82_2inc_2libofx_8h.html#a30">ofx_proc_transaction_cb</a> (const struct <a class="el" href="structOfxTransactionData.html">OfxTransactionData</a> data)</td></tr>
<tr><td> </td><td><font size=-1><em>The callback function for the <a class="el" href="structOfxTransactionData.html">OfxTransactionData</a> stucture.</em> <a href="#a30">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>CFCT int </td><td valign=bottom><a class="el" href="libofx-0_86_82_2inc_2libofx_8h.html#a31">ofx_proc_statement_cb</a> (const struct <a class="el" href="structOfxStatementData.html">OfxStatementData</a> data)</td></tr>
<tr><td> </td><td><font size=-1><em>The callback function for the <a class="el" href="structOfxStatementData.html">OfxStatementData</a> stucture.</em> <a href="#a31">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Main header file containing the LibOfx API.
<p>
This file should be included for all applications who use this API. This header file will work with both C and C++ programs. The entire API is made of the following structures and functions.
<p>
All of the following ofx_proc_* functions are callbacks (Except ofx_proc_file which is the entry point). They must be implemented by your program, but can be left empty if not needed. They are called each time the associated structure is filled by the library.
<p>
Important note: The variables associated with every data element have a _valid companion. Always check that data_valid == true before using. Not only will you ensure that the data is meaningfull, but also that pointers are valid and strings point to a null terminated string. Elements listed as mandatory are for information purpose only, do not trust the bank not to send you non-conforming data...
<p>
<p>
Definition in file <a class="el" href="libofx-0_86_82_2inc_2libofx_8h-source.html">libofx-0.6.2/inc/libofx.h</a>.<hr><h2>Function Documentation</h2>
<a name="a28" doxytag="libofx-0.6.2/inc/libofx.h::ofx_proc_account_cb"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CFCT int ofx_proc_account_cb </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const struct <a class="el" href="structOfxAccountData.html">OfxAccountData</a> </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The callback function for the <a class="el" href="structOfxAccountData.html">OfxAccountData</a> stucture.
<p>
<p>
The ofx_proc_account_cb event is always generated first, to allow the application to create accounts or ask the user to match an existing account before the ofx_proc_statement and ofx_proc_transaction event are received. An <a class="el" href="structOfxAccountData.html">OfxAccountData</a> is passed to this event.
<p>
Note however that this <a class="el" href="structOfxAccountData.html">OfxAccountData</a> structure will also be available as part of <a class="el" href="structOfxStatementData.html">OfxStatementData</a> structure passed to ofx_proc_statement event.
<p>
Definition at line <a class="el" href="ofx2qif_8c-source.html#l00217">217</a> of file <a class="el" href="ofx2qif_8c-source.html">ofx2qif.c</a>. </td>
</tr>
</table>
<a name="a26" doxytag="libofx-0.6.2/inc/libofx.h::ofx_proc_file"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CFCT int ofx_proc_file </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>argc</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>char * </td>
<td class="mdname" nowrap> <em>argv</em>[]</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
ofx_proc_file is the entry point of the library.
<p>
<p>
libofx_proc_file must be called by the client, with a list of 1 or more OFX files to be parsed in command line format.
<p>
Definition at line <a class="el" href="fx-0_86_82_2lib_2ofx__preproc_8cpp-source.html#l00034">34</a> of file <a class="el" href="fx-0_86_82_2lib_2ofx__preproc_8cpp-source.html">fx-0.6.2/lib/ofx_preproc.cpp</a>. </td>
</tr>
</table>
<a name="a29" doxytag="libofx-0.6.2/inc/libofx.h::ofx_proc_security_cb"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CFCT int ofx_proc_security_cb </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const struct <a class="el" href="structOfxSecurityData.html">OfxSecurityData</a> </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The callback function for the <a class="el" href="structOfxSecurityData.html">OfxSecurityData</a> stucture.
<p>
<p>
An ofx_proc_security_cb event is generated for any securities listed in the ofx file. It is generated after ofx_proc_statement but before ofx_proc_transaction. It is meant to be used to allow the client to create a new commodity or security (such as a new stock type). Please note however that this information is usually also available as part of each OfxtransactionData. An <a class="el" href="structOfxSecurityData.html">OfxSecurityData</a> structure is passed to this event.
<p>
Definition at line <a class="el" href="ofx2qif_8c-source.html#l00071">71</a> of file <a class="el" href="ofx2qif_8c-source.html">ofx2qif.c</a>. </td>
</tr>
</table>
<a name="a31" doxytag="libofx-0.6.2/inc/libofx.h::ofx_proc_statement_cb"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CFCT int ofx_proc_statement_cb </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const struct <a class="el" href="structOfxStatementData.html">OfxStatementData</a> </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The callback function for the <a class="el" href="structOfxStatementData.html">OfxStatementData</a> stucture.
<p>
<p>
The ofx_proc_statement_cb event is sent after all ofx_proc_transaction events have been sent. An <a class="el" href="structOfxStatementData.html">OfxStatementData</a> is passed to this event.
<p>
Definition at line <a class="el" href="ofx2qif_8c-source.html#l00158">158</a> of file <a class="el" href="ofx2qif_8c-source.html">ofx2qif.c</a>. </td>
</tr>
</table>
<a name="a27" doxytag="libofx-0.6.2/inc/libofx.h::ofx_proc_status_cb"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CFCT int ofx_proc_status_cb </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const struct <a class="el" href="structOfxStatusData.html">OfxStatusData</a> </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The callback function for the <a class="el" href="structOfxStatusData.html">OfxStatusData</a> stucture.
<p>
<p>
An ofx_proc_status_cb event is sent everytime the server has generated a OFX STATUS element. As such, it could be received at any time(but not during other events). An <a class="el" href="structOfxStatusData.html">OfxStatusData</a> structure is passed to this even.
<p>
Definition at line <a class="el" href="ofx2qif_8c-source.html#l00067">67</a> of file <a class="el" href="ofx2qif_8c-source.html">ofx2qif.c</a>. </td>
</tr>
</table>
<a name="a30" doxytag="libofx-0.6.2/inc/libofx.h::ofx_proc_transaction_cb"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CFCT int ofx_proc_transaction_cb </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const struct <a class="el" href="structOfxTransactionData.html">OfxTransactionData</a> </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The callback function for the <a class="el" href="structOfxTransactionData.html">OfxTransactionData</a> stucture.
<p>
<p>
An ofx_proc_transaction_cb event is generated for every transaction in the ofx response, after ofx_proc_statement (and possibly ofx_proc_security is generated. An <a class="el" href="structOfxTransactionData.html">OfxTransactionData</a> structure is passed to this event.
<p>
Definition at line <a class="el" href="ofx2qif_8c-source.html#l00075">75</a> of file <a class="el" href="ofx2qif_8c-source.html">ofx2qif.c</a>. </td>
</tr>
</table>
<hr><address><small>Generated on Sun Nov 24 20:26:32 2002 for LibOFX by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2002</small></address>
</body>
</html>
