---

OfxStatusData Struct Reference

An abstraction of an OFX STATUS element. More...

Public Types
enum	Severity { INFO, WARN, ERROR }
enum	Severity { INFO, WARN, ERROR }
enum	Severity { INFO, WARN, ERROR }
Data Fields
char	ofx_element_name [OFX_ELEMENT_NAME_LENGTH]
int	ofx_element_name_valid
int	code
char *	name
char *	description
int	code_valid
enum OfxStatusData::Severity	severity
int	severity_valid
char *	server_message
int	server_message_valid
char *	name
char *	description
enum OfxStatusData::Severity	severity
char *	server_message
char *	name
char *	description
enum OfxStatusData::Severity	severity
char *	server_message

---

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 93 of file inc/libofx.h.

---

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 112 of file test/include/libofx/libofx.h.

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 112 of file libofx-0.6.2/inc/libofx.h.

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 112 of file inc/libofx.h.

---

Field Documentation

int OfxStatusData::code

Status code Definition at line 106 of file test/include/libofx/libofx.h. Referenced by OfxStatusContainer::add_attribute, ofx_proc_security_cb, 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 109 of file test/include/libofx/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 108 of file test/include/libofx/libofx.h.

char* OfxStatusData::description

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

char* OfxStatusData::description

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

char* OfxStatusData::name

Code short name Definition at line 107 of file test/include/libofx/libofx.h.

char* OfxStatusData::name

Code short name Definition at line 107 of file libofx-0.6.2/inc/libofx.h.

char* OfxStatusData::name

Code short name Definition at line 107 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 100 of file test/include/libofx/libofx.h. Referenced by ofx_proc_security_cb, and 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 123 of file test/include/libofx/libofx.h.

char* OfxStatusData::server_message

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

char* OfxStatusData::server_message

Explanation given by the server for the Status Code. Especially important for generic errors. Definition at line 123 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

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:

• inc/libofx.h
• libofx-0.6.2/inc/libofx.h
• test/include/libofx/libofx.h

---