OfxStatusData Struct Reference


Detailed Description

An abstraction of an OFX STATUS element.

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 189 of file 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
const char * name
const char * description
int code_valid
enum OfxStatusData::Severity severity
int severity_valid

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

Member Enumeration Documentation

Severity of the error

Enumerator:
INFO  The status is an informational message
WARN  The status is a warning
ERROR  The status is a true error

Definition at line 208 of file libofx.h.


Field Documentation

Name of the OFX element this status is relevant to

Definition at line 196 of file libofx.h.

Status code

Definition at line 202 of file libofx.h.

const char* OfxStatusData::name

Code short name

Definition at line 203 of file libofx.h.

Code long description, from ofx_error_msg.h

Definition at line 204 of file libofx.h.

If code_valid is true, so is name and description (They are obtained from a lookup table)

Definition at line 205 of file libofx.h.

Explanation given by the server for the Status Code. Especially important for generic errors.

Definition at line 219 of file libofx.h.


The documentation for this struct was generated from the following file:

Generated on Fri Mar 20 18:45:41 2009 for LibOFX by  doxygen 1.5.5