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 96 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

Public Types

Data Fields

Additional information

To give a minimum of context, the name of the OFX SGML element where this 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

Member Enumeration Documentation

enum OfxStatusData::Severity

Severity of the error
Enumeration values:

INFO The status is an informational message

WARN The status is a warning

ERROR The status is a true error

Definition at line 115 of file libofx-0.6.5/inc/libofx.h.

Field Documentation

int OfxStatusData::code

Status code
Definition at line 109 of file libofx-0.6.5/inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().

int OfxStatusData::code_valid

If code_valid is true, so is name and description (They are obtained from a lookup table)
Definition at line 112 of file libofx-0.6.5/inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().

char* OfxStatusData::description

Code long description, from ofx_error_msg.h
Definition at line 111 of file libofx-0.6.5/inc/libofx.h.

char* OfxStatusData::description

Code long description, from ofx_error_msg.h
Definition at line 111 of file inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().

char* OfxStatusData::name

Code short name
Definition at line 110 of file libofx-0.6.5/inc/libofx.h.

char* OfxStatusData::name

Code short name
Definition at line 110 of file inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().

int OfxStatusData::ofx_element_name_valid

Name of the OFX element this status is relevant to
Definition at line 103 of file libofx-0.6.5/inc/libofx.h.
Referenced by ofx_proc_status_cb().

char* OfxStatusData::server_message

Explanation given by the server for the Status Code. Especially important for generic errors.
Definition at line 126 of file libofx-0.6.5/inc/libofx.h.

char* OfxStatusData::server_message

Explanation given by the server for the Status Code. Especially important for generic errors.
Definition at line 126 of file inc/libofx.h.
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().

enum OfxStatusData::Severity OfxStatusData::severity

Severity of the error

enum OfxStatusData::Severity OfxStatusData::severity

Severity of the error
Referenced by OfxStatusContainer::add_attribute(), and ofx_proc_status_cb().

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

Generated on Fri Sep 12 00:35:47 2003 for LibOFX by

1.3.3


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
Public Types
Data Fields
Additional information
To give a minimum of context, the name of the OFX SGML element where this 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