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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
<!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: OfxStatusData Struct 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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</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('structOfxStatusData.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">OfxStatusData Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An abstraction of an OFX STATUS element.
<a href="structOfxStatusData.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Additional information</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>To give a minimum of context, the name of the OFX SGML element where this <STATUS> is located is available. </p>
</div></td></tr>
<tr class="memitem:ad49b449f9d4bf1746d71728cd1f5b925"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad49b449f9d4bf1746d71728cd1f5b925"></a>
char </td><td class="memItemRight" valign="bottom"><b>ofx_element_name</b> [OFX_ELEMENT_NAME_LENGTH]</td></tr>
<tr class="separator:ad49b449f9d4bf1746d71728cd1f5b925"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a011f73b45f88aac63ec44727ed6b306d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a011f73b45f88aac63ec44727ed6b306d">ofx_element_name_valid</a></td></tr>
<tr class="separator:a011f73b45f88aac63ec44727ed6b306d"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">OFX optional elements</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The OFX spec defines the following elements as optional. If the associated *_valid is true, the corresponding element is present and the associated variable contains valid data. </p>
</div></td></tr>
<tr class="memitem:ab248a3a90d3217b9201d5e00361ab8f2"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#ab248a3a90d3217b9201d5e00361ab8f2">server_message</a></td></tr>
<tr class="separator:ab248a3a90d3217b9201d5e00361ab8f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab07b45a40bc313455c998b5566e605d3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab07b45a40bc313455c998b5566e605d3"></a>
int </td><td class="memItemRight" valign="bottom"><b>server_message_valid</b></td></tr>
<tr class="separator:ab07b45a40bc313455c998b5566e605d3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
OFX mandatory elements</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp39b20152d44093a40e1db27e01bec968"></a> The OFX spec defines the following elements as mandatory. The associated variables should all contain valid data but you should not trust the servers. Check if the associated *_valid is true before using them. </p>
</td></tr>
<tr class="memitem:a9e9ac7b5db3c10f2f42cc0225a016187"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187">Severity</a> { <br/>
  <a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0">INFO</a>,
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8">WARN</a>,
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb">ERROR</a>,
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0">INFO</a>,
<br/>
  <a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8">WARN</a>,
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb">ERROR</a>
<br/>
}</td></tr>
<tr class="separator:a9e9ac7b5db3c10f2f42cc0225a016187"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e9ac7b5db3c10f2f42cc0225a016187"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187">Severity</a> { <br/>
  <a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0">INFO</a>,
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8">WARN</a>,
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb">ERROR</a>,
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0">INFO</a>,
<br/>
  <a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8">WARN</a>,
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb">ERROR</a>
<br/>
}</td></tr>
<tr class="separator:a9e9ac7b5db3c10f2f42cc0225a016187"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c331e4729b921be2eaf234498ffe19c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a7c331e4729b921be2eaf234498ffe19c">code</a></td></tr>
<tr class="separator:a7c331e4729b921be2eaf234498ffe19c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37c109348c4a1886e3b21b323e3d3205"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a37c109348c4a1886e3b21b323e3d3205">name</a></td></tr>
<tr class="separator:a37c109348c4a1886e3b21b323e3d3205"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad489133cc19edf04244074d107919945"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#ad489133cc19edf04244074d107919945">description</a></td></tr>
<tr class="separator:ad489133cc19edf04244074d107919945"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea08b7a14fa90d26ef192fab683e09d1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#aea08b7a14fa90d26ef192fab683e09d1">code_valid</a></td></tr>
<tr class="separator:aea08b7a14fa90d26ef192fab683e09d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf003dd26583267035b01bc479704164"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf003dd26583267035b01bc479704164"></a>
enum <a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187">OfxStatusData::Severity</a> </td><td class="memItemRight" valign="bottom"><b>severity</b></td></tr>
<tr class="separator:adf003dd26583267035b01bc479704164"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade9a52735f94e5c9966492fde9e35d04"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade9a52735f94e5c9966492fde9e35d04"></a>
int </td><td class="memItemRight" valign="bottom"><b>severity_valid</b></td></tr>
<tr class="separator:ade9a52735f94e5c9966492fde9e35d04"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An abstraction of an OFX STATUS element. </p>
<p>The <a class="el" href="structOfxStatusData.html" title="An abstraction of an OFX STATUS element. ">OfxStatusData</a> structure represents a STATUS OFX element sent by the OFX server. Be carefull, you do not have much context except the entity name so your application should probably ignore this status if code==0. However, you should display a message if the status in non-zero, since an error probably occurred on the server side.</p>
<p>In a future version of this API, <a class="el" href="structOfxStatusData.html" title="An abstraction of an OFX STATUS element. ">OfxStatusData</a> structures might be linked from the OFX structures they are related to. </p>
<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00208">208</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187">OfxStatusData::Severity</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Severity of the error </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0"></a>INFO</em> </td><td class="fielddoc">
<p>The status is an informational message </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8"></a>WARN</em> </td><td class="fielddoc">
<p>The status is a warning </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb"></a>ERROR</em> </td><td class="fielddoc">
<p>The status is a true error </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0"></a>INFO</em> </td><td class="fielddoc">
<p>The status is an informational message </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8"></a>WARN</em> </td><td class="fielddoc">
<p>The status is a warning </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb"></a>ERROR</em> </td><td class="fielddoc">
<p>The status is a true error </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00228">228</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187">OfxStatusData::Severity</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Severity of the error </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0"></a>INFO</em> </td><td class="fielddoc">
<p>The status is an informational message </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8"></a>WARN</em> </td><td class="fielddoc">
<p>The status is a warning </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb"></a>ERROR</em> </td><td class="fielddoc">
<p>The status is a true error </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0"></a>INFO</em> </td><td class="fielddoc">
<p>The status is an informational message </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8"></a>WARN</em> </td><td class="fielddoc">
<p>The status is a warning </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb"></a>ERROR</em> </td><td class="fielddoc">
<p>The status is a true error </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="libofx-0_89_810_2inc_2libofx_8h_source.html#l00228">228</a> of file <a class="el" href="libofx-0_89_810_2inc_2libofx_8h_source.html">libofx-0.9.10/inc/libofx.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a7c331e4729b921be2eaf234498ffe19c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OfxStatusData::code</td>
</tr>
</table>
</div><div class="memdoc">
<p>Status code </p>
<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00222">222</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
<p>Referenced by <a class="el" href="ofx__containers__misc_8cpp_source.html#l00094">OfxStatusContainer::add_attribute()</a>.</p>
</div>
</div>
<a class="anchor" id="aea08b7a14fa90d26ef192fab683e09d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OfxStatusData::code_valid</td>
</tr>
</table>
</div><div class="memdoc">
<p>If code_valid is true, so is name and description (They are obtained from a lookup table) </p>
<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00225">225</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
<p>Referenced by <a class="el" href="ofx__containers__misc_8cpp_source.html#l00094">OfxStatusContainer::add_attribute()</a>.</p>
</div>
</div>
<a class="anchor" id="ad489133cc19edf04244074d107919945"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * OfxStatusData::description</td>
</tr>
</table>
</div><div class="memdoc">
<p>Code long description, from ofx_error_msg.h </p>
<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00224">224</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
<p>Referenced by <a class="el" href="ofx__containers__misc_8cpp_source.html#l00094">OfxStatusContainer::add_attribute()</a>.</p>
</div>
</div>
<a class="anchor" id="a37c109348c4a1886e3b21b323e3d3205"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * OfxStatusData::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Code short name </p>
<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00223">223</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
<p>Referenced by <a class="el" href="ofx__containers__misc_8cpp_source.html#l00094">OfxStatusContainer::add_attribute()</a>.</p>
</div>
</div>
<a class="anchor" id="a011f73b45f88aac63ec44727ed6b306d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OfxStatusData::ofx_element_name_valid</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the OFX element this status is relevant to </p>
<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00216">216</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab248a3a90d3217b9201d5e00361ab8f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * OfxStatusData::server_message</td>
</tr>
</table>
</div><div class="memdoc">
<p>Explanation given by the server for the Status Code. Especially important for generic errors. </p>
<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00241">241</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
<p>Referenced by <a class="el" href="ofx__containers__misc_8cpp_source.html#l00094">OfxStatusContainer::add_attribute()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a></li>
</ul>
</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="structOfxStatusData.html">OfxStatusData</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>
|
