File: ofx__error__msg_8hh.html

package info (click to toggle)
libofx 1%3A0.9.10-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 11,128 kB
  • sloc: sh: 11,428; cpp: 6,242; ansic: 2,459; makefile: 170; xml: 61
file content (157 lines) | stat: -rw-r--r-- 7,874 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibOFX: ofx_error_msg.hh File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibOFX
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('ofx__error__msg_8hh.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">ofx_error_msg.hh File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>OFX error code management functionnality.  
<a href="#details">More...</a></p>

<p><a href="ofx__error__msg_8hh_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structErrorMsg.html">ErrorMsg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An abstraction of an OFX error code sent by an OFX server.  <a href="structErrorMsg.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adac162b52803cc0814b829813ad3a5aa"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structErrorMsg.html">ErrorMsg</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__error__msg_8hh.html#adac162b52803cc0814b829813ad3a5aa">find_error_msg</a> (int param_code)</td></tr>
<tr class="memdesc:adac162b52803cc0814b829813ad3a5aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retreive error code descriptions.  <a href="#adac162b52803cc0814b829813ad3a5aa">More...</a><br/></td></tr>
<tr class="separator:adac162b52803cc0814b829813ad3a5aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a55330fe48f8c210038dfaae0ed8dd608"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structErrorMsg.html">ErrorMsg</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ofx__error__msg_8hh.html#a55330fe48f8c210038dfaae0ed8dd608">error_msgs_list</a> []</td></tr>
<tr class="memdesc:a55330fe48f8c210038dfaae0ed8dd608"><td class="mdescLeft">&#160;</td><td class="mdescRight">List known error codes.  <a href="#a55330fe48f8c210038dfaae0ed8dd608">More...</a><br/></td></tr>
<tr class="separator:a55330fe48f8c210038dfaae0ed8dd608"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>OFX error code management functionnality. </p>

<p>Definition in file <a class="el" href="ofx__error__msg_8hh_source.html">ofx_error_msg.hh</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="adac162b52803cc0814b829813ad3a5aa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structErrorMsg.html">ErrorMsg</a> find_error_msg </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>param_code</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retreive error code descriptions. </p>
<p>The find_error_msg function will take an ofx error number, and return an <a class="el" href="structErrorMsg.html" title="An abstraction of an OFX error code sent by an OFX server. ">ErrorMsg</a> structure with detailled information about the error, including the error name and long description </p>

<p>Definition at line <a class="el" href="ofx__error__msg_8hh_source.html#l00130">130</a> of file <a class="el" href="ofx__error__msg_8hh_source.html">ofx_error_msg.hh</a>.</p>

<p>Referenced by <a class="el" href="ofx__containers__misc_8cpp_source.html#l00094">OfxStatusContainer::add_attribute()</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a55330fe48f8c210038dfaae0ed8dd608"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structErrorMsg.html">ErrorMsg</a> error_msgs_list[]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>List known error codes. </p>
<p>The error_msgs_list table contains all past and present OFX error codes up to the OFX 2.01 specification </p>

<p>Definition at line <a class="el" href="ofx__error__msg_8hh_source.html#l00034">34</a> of file <a class="el" href="ofx__error__msg_8hh_source.html">ofx_error_msg.hh</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_92da12de3a7e435e6ac7f35fe8c95afc.html">lib</a></li><li class="navelem"><a class="el" href="ofx__error__msg_8hh.html">ofx_error_msg.hh</a></li>
    <li class="footer">Generated on Fri Sep 12 2014 15:59:21 for LibOFX by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>