---

statusreport.h File Reference

MessageReference, StatusReport and their C wrappers. More...

#include <openhbci/dllimport.h>
#include <string>
#include <list>
#include <openhbci/date.h>

Go to the source code of this file.

Namespaces
namespace	HBCI
list_HBCI_StatusReport
typedef void *(*	list_HBCI_StatusReport_cb )(const HBCI_StatusReport *value, void *user_data)
unsigned int	list_HBCI_StatusReport_size (const list_HBCI_StatusReport *l)
void *	list_HBCI_StatusReport_foreach (const list_HBCI_StatusReport *l, list_HBCI_StatusReport_cb func, void *user_data)
HBCI_MessageReference
HBCI_MessageReference *	HBCI_MessageReference_new (const char *did, int msgnum)
HBCI_MessageReference *	HBCI_MessageReference_new_deg (const char *deg)
void	HBCI_MessageReference_delete (HBCI_MessageReference *h)
const char *	HBCI_MessageReference_dialogId (const HBCI_MessageReference *h)
int	HBCI_MessageReference_messageNumber (const HBCI_MessageReference *h)
char *	HBCI_MessageReference_toString (const HBCI_MessageReference *h)
int	HBCI_MessageReference_equal (const HBCI_MessageReference *h1, const HBCI_MessageReference *h2)
int	HBCI_MessageReference_cmp (const HBCI_MessageReference *h1, const HBCI_MessageReference *h2)
HBCI_StatusReport
const HBCI_Date *	HBCI_StatusReport_date (const HBCI_StatusReport *h)
const HBCI_Time *	HBCI_StatusReport_time (const HBCI_StatusReport *h)
int	HBCI_StatusReport_result (const HBCI_StatusReport *h)
const char *	HBCI_StatusReport_groupReference (const HBCI_StatusReport *h)
const char *	HBCI_StatusReport_resultText (const HBCI_StatusReport *h)
const HBCI_MessageReference *	HBCI_StatusReport_messageReference (const HBCI_StatusReport *h)
int	HBCI_StatusReport_segment (const HBCI_StatusReport *h)
char *	HBCI_StatusReport_dump (const HBCI_StatusReport *h)
Typedefs
typedef HBCI::MessageReference	HBCI_MessageReference
typedef HBCI::StatusReport	HBCI_StatusReport
typedef std::list< HBCI::StatusReport >	list_HBCI_StatusReport

---

Detailed Description

MessageReference, StatusReport and their C wrappers.

---

Typedef Documentation

typedef HBCI::MessageReference HBCI_MessageReference

typedef HBCI::StatusReport HBCI_StatusReport

typedef std::list<HBCI::StatusReport> list_HBCI_StatusReport

typedef void*(* list_HBCI_StatusReport_cb)(const HBCI_StatusReport* value, void *user_data)

Callback function for list_HBCI_StatusReport_foreach.

---

Function Documentation

int HBCI_MessageReference_cmp (  const HBCI_MessageReference *    h1, const HBCI_MessageReference *    h2 )

Comparison. Returns -1 when MessageReference h1 is smaller than h2, returns 0 when equal, and returns 1 when h1 is greater than h2. The dialogId are compared lexicographically, and the messageNumber numerically.

void HBCI_MessageReference_delete (  HBCI_MessageReference *    h )

Destructor

const char* HBCI_MessageReference_dialogId (  const HBCI_MessageReference *    h )

Returns the dialog id.

int HBCI_MessageReference_equal (  const HBCI_MessageReference *    h1, const HBCI_MessageReference *    h2 )

Equality

int HBCI_MessageReference_messageNumber (  const HBCI_MessageReference *    h )

Returns the message number.

HBCI_MessageReference* HBCI_MessageReference_new (  const char *    did, int    msgnum )

Constructor with dialog id and message number.

HBCI_MessageReference* HBCI_MessageReference_new_deg (  const char *    deg )

Constructor for a HBCI data element group (DEG). This is just the same string as the one returned by toString(). (FIXME: is this correct?)

char* HBCI_MessageReference_toString (  const HBCI_MessageReference *    h )

Returns the HBCI-representation of a message reference in one string. Note: The returned char array is owned by the caller and must be free'd when no longer needed

const HBCI_Date* HBCI_StatusReport_date (  const HBCI_StatusReport *    h )

Returns the date when this status report was valid.

char* HBCI_StatusReport_dump (  const HBCI_StatusReport *    h )

Returns a long string containing all information of this status report; mainly intended for debugging. Note: The returned char array is owned by the caller and must be free'd when no longer needed!

const char* HBCI_StatusReport_groupReference (  const HBCI_StatusReport *    h )

Returns the message group this status report belongs to (FIXME: is this correct?)

const HBCI_MessageReference* HBCI_StatusReport_messageReference (  const HBCI_StatusReport *    h )

Returns the message reference to find the message that this status report belongs to.

int HBCI_StatusReport_result (  const HBCI_StatusReport *    h )

Returns the HBCI result code of this status report.

const char* HBCI_StatusReport_resultText (  const HBCI_StatusReport *    h )

Returns the clear text message of this status report.

int HBCI_StatusReport_segment (  const HBCI_StatusReport *    h )

Returns the segment number inside the referred message (by messageReference() ) that this status report belongs to.

const HBCI_Time* HBCI_StatusReport_time (  const HBCI_StatusReport *    h )

Returns the time when this status report was valid.

void* list_HBCI_StatusReport_foreach (  const list_HBCI_StatusReport *    l, list_HBCI_StatusReport_cb    func, void *    user_data )

Traverses the list, calling the callback function 'func' on each list element. Traversal will stop when 'func' returns a non-NULL value, and the routine will return with that value. Otherwise the routine will return NULL. Parameters: l  The list to traverse. func  The function to be called with each list element. user_data  A pointer passed on to the function 'func'. Returns : The non-NULL pointer returned by 'func' as soon as it returns one. Otherwise (i.e. 'func' always returns NULL) returns NULL. Author: Christian Stimming <stimming@tuhh.de>

unsigned int list_HBCI_StatusReport_size (  const list_HBCI_StatusReport *    l )

Returns the size of the list.

---