---

api.h File Reference

Contains the definition of HBCI::API as well as its HBCI_API C wrapper functions. More...

#include <string>
#include <list>
#include <openhbci/dllimport.h>
#include <openhbci/hbci.h>
#include <openhbci/pointer.h>
#include <openhbci/error.h>
#include <openhbci/bank.h>
#include <openhbci/account.h>
#include <openhbci/medium.h>
#include <openhbci/mediumpluginlist.h>
#include <openhbci/adminjobs.h>
#include <openhbci/loader.h>
#include <openhbci/outbox.h>
#include <openhbci/mediumplugin.h>
#include <openhbci/mediumpluginfile.h>
#include <openhbci/progressmonitor.h>
#include <openhbci/outboxjob.h>

Go to the source code of this file.

Namespaces
namespace	HBCI
Object Constructor
HBCI_API *	HBCI_API_new (int readonly, int retrievalOnly)
void	HBCI_API_delete (HBCI_API *h)
HBCI_Hbci *	HBCI_API_Hbci (HBCI_API *h)
File operations
HBCI_Error *	HBCI_API_loadEnvironment (HBCI_API *h, const char *filename)
HBCI_Error *	HBCI_API_saveEnvironment (const HBCI_API *h, const char *filename)
Object Retrieval
const list_HBCI_Bank *	HBCI_API_bankList (const HBCI_API *h)
HBCI_Bank *	HBCI_API_findBank (const HBCI_API *h, int country, const char *bankCode)
HBCI_Medium *	HBCI_API_findMedium (const HBCI_API *h, const char *name)
Convenience Object Retrieval
int	HBCI_API_totalAccounts (const HBCI_API *h)
int	HBCI_API_totalUsers (const HBCI_API *h)
Manage Objects
HBCI_Error *	HBCI_API_addBank (HBCI_API *h, HBCI_Bank *b, int autoDelete)
OutboxJob Management
HBCI_Error *	HBCI_API_addJob (HBCI_API *h, HBCI_OutboxJob *j)
HBCI_Error *	HBCI_API_executeQueue (HBCI_API *h, int changesAllowed)
void	HBCI_API_clearQueueByResult (HBCI_API *h, OutboxJob_Result result)
void	HBCI_API_clearQueueByStatus (HBCI_API *h, OutboxJob_Status status)
User Interaction
void	HBCI_API_setMonitor (HBCI_API *h, HBCI_ProgressMonitor *m, int autoDelete)
Factory Methods
HBCI_Bank *	HBCI_API_bankFactory (const HBCI_API *h, int country, const char *bankCode, const char *server)
HBCI_Medium *	HBCI_API_createNewMedium (HBCI_API *h, const char *mtype, int readonly, int country, const char *bankId, const char *userid, const char *name, HBCI_Error **err)
MediumType	HBCI_API_mediumType (HBCI_API *h, const char *mtype)
HBCI_MediumPluginList *	HBCI_API_enumerateMediumPlugins (HBCI_API *h)
Static Factory Methods
HBCI_User *	HBCI_API_userFactory (HBCI_Bank *b, HBCI_Medium *m, int mediumAutoDelete, const char *userid)
HBCI_Customer *	HBCI_API_customerFactory (HBCI_User *u, const char *id, const char *custName)
HBCI_Account *	HBCI_API_accountFactory (HBCI_Bank *b, const char *accountId, const char *accountSubId)
Defines
#define	HBCIAPP_CONFIG_MODE
Typedefs
typedef HBCI::API	HBCI_API
	This is the C-accessible type for the central OpenHBCI class HBCI::API.

---

Detailed Description

Contains the definition of HBCI::API as well as its HBCI_API C wrapper functions.

---

Define Documentation

#define HBCIAPP_CONFIG_MODE

Value: (\ PARSER_FLAGS_SKIP_BLANKS |\ PARSER_FLAGS_CUT_BLANKS |\ PARSER_FLAGS_REMOVE_QUOTATION_MARKS |\ CONFIG_MODE_QUOTED_VALUES |\ CONFIG_MODE_UNIQUE_VARS |\ CONFIG_MODE_RETURN_ON_ERROR |\ CONFIG_MODE_WRITE_GROUP_NAME |\ CONFIG_MODE_IGNORE_GROUP_CASE |\ CONFIG_MODE_IGNORE_VAR_CASE |\ CONFIG_MODE_ALLOW_EMPTY_VALUES |\ CONFIG_MODE_ONE_VALUE_PER_LINE |\ CONFIG_MODE_BACKSLASH_CONTINUATION)

---