The OfxStatusData 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.
In a future version of this API, OfxStatusData structures might be linked from the OFX structures they are related to.
Definition at line 175 of file inc/libofx.h.
OFX mandatory elements | |
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. | |
enum | Severity { INFO, WARN, ERROR } |
int | code |
char * | name |
char * | description |
int | code_valid |
enum OfxStatusData::Severity | severity |
int | severity_valid |
OFX mandatory elements | |
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. | |
enum | Severity { INFO, WARN, ERROR } |
char * | name |
char * | description |
enum OfxStatusData::Severity | severity |
Data Fields | |
Additional information | |
To give a minimum of context, the name of the OFX SGML element where this <STATUS> is located is available. | |
char | ofx_element_name [OFX_ELEMENT_NAME_LENGTH] |
int | ofx_element_name_valid |
OFX optional elements | |
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. | |
char * | server_message |
int | server_message_valid |
OFX optional elements | |
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. | |
char * | server_message |
Severity of the error
INFO | The status is an informational message |
WARN | The status is a warning |
ERROR | The status is a true error |
Definition at line 194 of file libofx-0.8.2/inc/libofx.h.
Severity of the error
INFO | The status is an informational message |
WARN | The status is a warning |
ERROR | The status is a true error |
Definition at line 194 of file inc/libofx.h.
Status code
Definition at line 188 of file inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().
If code_valid is true, so is name and description (They are obtained from a lookup table)
Definition at line 191 of file inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().
Code long description, from ofx_error_msg.h
Definition at line 190 of file libofx-0.8.2/inc/libofx.h.
Code long description, from ofx_error_msg.h
Definition at line 190 of file inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().
char* OfxStatusData::name |
Code short name
Definition at line 189 of file libofx-0.8.2/inc/libofx.h.
char* OfxStatusData::name |
Code short name
Definition at line 189 of file inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().
Name of the OFX element this status is relevant to
Definition at line 182 of file inc/libofx.h.
Referenced by ofx_proc_status_cb().
Explanation given by the server for the Status Code. Especially important for generic errors.
Definition at line 205 of file libofx-0.8.2/inc/libofx.h.
Explanation given by the server for the Status Code. Especially important for generic errors.
Definition at line 205 of file inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), ofx_proc_status_cb(), and OfxStatusContainer::~OfxStatusContainer().
Severity of the error
Severity of the error
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().