Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > 2c293755396b61d5feb669b6e142f13b > files > 214

lib64ofx-devel-0.9.9-2.mga4.x86_64.rpm

<!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"/>
<title>LibOFX: OfxStatusData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<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>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;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&#160;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('structOfxStatusData.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">OfxStatusData Struct Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="OfxStatusData" -->
<p>An abstraction of an OFX STATUS element.  
 <a href="structOfxStatusData.html#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><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 &lt;STATUS&gt; is located is available. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad49b449f9d4bf1746d71728cd1f5b925"></a><!-- doxytag: member="OfxStatusData::ofx_element_name" ref="ad49b449f9d4bf1746d71728cd1f5b925" args="[OFX_ELEMENT_NAME_LENGTH]" -->
char&#160;</td><td class="memItemRight" valign="bottom"><b>ofx_element_name</b> [OFX_ELEMENT_NAME_LENGTH]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a011f73b45f88aac63ec44727ed6b306d">ofx_element_name_valid</a></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><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#ab248a3a90d3217b9201d5e00361ab8f2">server_message</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab07b45a40bc313455c998b5566e605d3"></a><!-- doxytag: member="OfxStatusData::server_message_valid" ref="ab07b45a40bc313455c998b5566e605d3" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>server_message_valid</b></td></tr>
<tr><td colspan="2"><h2><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><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187">Severity</a> { <br/>
&#160;&#160;<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/>
&#160;&#160;<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8">WARN</a>, 
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb">ERROR</a>
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187">Severity</a> { <br/>
&#160;&#160;<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/>
&#160;&#160;<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8">WARN</a>, 
<a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb">ERROR</a>
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a7c331e4729b921be2eaf234498ffe19c">code</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#a37c109348c4a1886e3b21b323e3d3205">name</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#ad489133cc19edf04244074d107919945">description</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxStatusData.html#aea08b7a14fa90d26ef192fab683e09d1">code_valid</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf003dd26583267035b01bc479704164"></a><!-- doxytag: member="OfxStatusData::severity" ref="adf003dd26583267035b01bc479704164" args="" -->
enum <a class="el" href="structOfxStatusData.html#a9e9ac7b5db3c10f2f42cc0225a016187">OfxStatusData::Severity</a>&#160;</td><td class="memItemRight" valign="bottom"><b>severity</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade9a52735f94e5c9966492fde9e35d04"></a><!-- doxytag: member="OfxStatusData::severity_valid" ref="ade9a52735f94e5c9966492fde9e35d04" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>severity_valid</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>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><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187"></a><!-- doxytag: member="OfxStatusData::Severity" ref="a9e9ac7b5db3c10f2f42cc0225a016187" args="" -->
<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>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0"></a><!-- doxytag: member="INFO" ref="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0" args="" -->INFO</em>&nbsp;</td><td>
<p>The status is an informational message </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8"></a><!-- doxytag: member="WARN" ref="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8" args="" -->WARN</em>&nbsp;</td><td>
<p>The status is a warning </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb"></a><!-- doxytag: member="ERROR" ref="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb" args="" -->ERROR</em>&nbsp;</td><td>
<p>The status is a true error </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0"></a><!-- doxytag: member="INFO" ref="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0" args="" -->INFO</em>&nbsp;</td><td>
<p>The status is an informational message </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8"></a><!-- doxytag: member="WARN" ref="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8" args="" -->WARN</em>&nbsp;</td><td>
<p>The status is a warning </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb"></a><!-- doxytag: member="ERROR" ref="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb" args="" -->ERROR</em>&nbsp;</td><td>
<p>The status is a true error </p>
</td></tr>
</table>
</dd>
</dl>

<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><!-- doxytag: member="OfxStatusData::Severity" ref="a9e9ac7b5db3c10f2f42cc0225a016187" args="" -->
<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>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0"></a><!-- doxytag: member="INFO" ref="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0" args="" -->INFO</em>&nbsp;</td><td>
<p>The status is an informational message </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8"></a><!-- doxytag: member="WARN" ref="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8" args="" -->WARN</em>&nbsp;</td><td>
<p>The status is a warning </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb"></a><!-- doxytag: member="ERROR" ref="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb" args="" -->ERROR</em>&nbsp;</td><td>
<p>The status is a true error </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0"></a><!-- doxytag: member="INFO" ref="a9e9ac7b5db3c10f2f42cc0225a016187a607c1edcec0561c65dda6055bdd970c0" args="" -->INFO</em>&nbsp;</td><td>
<p>The status is an informational message </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8"></a><!-- doxytag: member="WARN" ref="a9e9ac7b5db3c10f2f42cc0225a016187ad567eb2fcd64f55542fa48802b2e43d8" args="" -->WARN</em>&nbsp;</td><td>
<p>The status is a warning </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb"></a><!-- doxytag: member="ERROR" ref="a9e9ac7b5db3c10f2f42cc0225a016187a38b731d21638db06ec36499e258c9cbb" args="" -->ERROR</em>&nbsp;</td><td>
<p>The status is a true error </p>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="libofx-0_89_88_2inc_2libofx_8h_source.html#l00228">228</a> of file <a class="el" href="libofx-0_89_88_2inc_2libofx_8h_source.html">libofx-0.9.8/inc/libofx.h</a>.</p>

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a7c331e4729b921be2eaf234498ffe19c"></a><!-- doxytag: member="OfxStatusData::code" ref="a7c331e4729b921be2eaf234498ffe19c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structOfxStatusData.html#a7c331e4729b921be2eaf234498ffe19c">OfxStatusData::code</a></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><!-- doxytag: member="OfxStatusData::code_valid" ref="aea08b7a14fa90d26ef192fab683e09d1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structOfxStatusData.html#aea08b7a14fa90d26ef192fab683e09d1">OfxStatusData::code_valid</a></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><!-- doxytag: member="OfxStatusData::description" ref="ad489133cc19edf04244074d107919945" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * <a class="el" href="structOfxStatusData.html#ad489133cc19edf04244074d107919945">OfxStatusData::description</a></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><!-- doxytag: member="OfxStatusData::name" ref="a37c109348c4a1886e3b21b323e3d3205" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * <a class="el" href="structOfxStatusData.html#a37c109348c4a1886e3b21b323e3d3205">OfxStatusData::name</a></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><!-- doxytag: member="OfxStatusData::ofx_element_name_valid" ref="a011f73b45f88aac63ec44727ed6b306d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structOfxStatusData.html#a011f73b45f88aac63ec44727ed6b306d">OfxStatusData::ofx_element_name_valid</a></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><!-- doxytag: member="OfxStatusData::server_message" ref="ab248a3a90d3217b9201d5e00361ab8f2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char * <a class="el" href="structOfxStatusData.html#ab248a3a90d3217b9201d5e00361ab8f2">OfxStatusData::server_message</a></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 files:<ul>
<li><a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a></li>
<li><a class="el" href="libofx-0_89_88_2inc_2libofx_8h_source.html">libofx-0.9.8/inc/libofx.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="structOfxStatusData.html">OfxStatusData</a>      </li>
      <li class="footer">Generated on Wed Apr 17 2013 22:12:00 for LibOFX by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
    </ul>
  </div>

</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional