banking.h File Reference


Detailed Description

The main interface of the aqbanking library.

Definition in file aqbanking/banking.h.

#include <gwenhywfar/inherit.h>
#include <gwenhywfar/types.h>
#include <gwenhywfar/db.h>
#include <gwenhywfar/stringlist.h>
#include <gwenhywfar/plugindescr.h>
#include <aqbanking/error.h>
#include <aqbanking/version.h>
#include <aqbanking/banking_virt.h>
#include <aqbanking/banking_imex.h>
#include <aqbanking/banking_info.h>
#include <aqbanking/banking_ob.h>
#include <aqbanking/banking_simple.h>
#include <aqbanking/provider.h>

Go to the source code of this file.

Defines

#define AB_PM_LIBNAME   "aqbanking"
#define AB_PM_SYSCONFDIR   "sysconfdir"
#define AB_PM_DATADIR   "datadir"
#define AB_PM_WIZARDDIR   "wizarddir"
#define AB_PM_LOCALEDIR   "localedir"
Extensions supported by the application
#define AB_BANKING_EXTENSION_NONE   0x00000000

Typedefs

typedef struct AB_BANKING AB_BANKING

Functions

Constructor, Destructor, Init, Fini
This object is prepared to be inherited (using GWEN_INHERIT_SETDATA).

AB_BANKINGAB_Banking_new (const char *appName, const char *dname, uint32_t extensions)
void AB_Banking_free (AB_BANKING *ab)
int AB_Banking_Init (AB_BANKING *ab)
int AB_Banking_Fini (AB_BANKING *ab)
int AB_Banking_OnlineInit (AB_BANKING *ab)
int AB_Banking_OnlineFini (AB_BANKING *ab)
int AB_Banking_Save (AB_BANKING *ab)
Working With Backends
Working with backends - as far as the frontend is concerned - is very simple.

An application typically does this upon initial setup:

Please note that for security reasons a backend is only used when it has explicitly been activated. So if any backend is added to AqBanking by installing it you will still need to activate it to make use of it.

However, the activation state is preserved across shutdowns of AqBanking, so a backend remains active until it is explicitly deactivated.

const GWEN_STRINGLIST * AB_Banking_GetActiveProviders (const AB_BANKING *ab)
AQBANKING_DEPRECATED int AB_Banking_ActivateProvider (AB_BANKING *ab, const char *backend)
AQBANKING_DEPRECATED int AB_Banking_DeactivateProvider (AB_BANKING *ab, const char *backend)
AQBANKING_DEPRECATED int AB_Banking_IsProviderActive (AB_BANKING *ab, const char *backend)
int AB_Banking_FindWizard (AB_BANKING *ab, const char *backend, const char *frontends, GWEN_BUFFER *pbuf)
int AB_Banking_FindDebugger (AB_BANKING *ab, const char *backend, const char *frontends, GWEN_BUFFER *pbuf)
Application Data
Applications may let AqBanking store global application specific data. In addition, account specific data can also be stored using AB_Account_GetAppData.

const char * AB_Banking_GetAppName (const AB_BANKING *ab)
const char * AB_Banking_GetEscapedAppName (const AB_BANKING *ab)
GWEN_DB_NODE * AB_Banking_GetAppData (AB_BANKING *ab)
GWEN_DB_NODE * AB_Banking_GetSharedData (AB_BANKING *ab, const char *name)
int AB_Banking_GetUserDataDir (const AB_BANKING *ab, GWEN_BUFFER *buf)
int AB_Banking_GetAppUserDataDir (const AB_BANKING *ab, GWEN_BUFFER *buf)
int AB_Banking_GetSharedDataDir (const AB_BANKING *ab, const char *name, GWEN_BUFFER *buf)
void * AB_Banking_GetUserData (AB_BANKING *ab)
void AB_Banking_SetUserData (AB_BANKING *ab, void *user_data)
Plugin Handling
GWEN_PLUGIN_DESCRIPTION_LIST2 * AB_Banking_GetProviderDescrs (AB_BANKING *ab)
GWEN_PLUGIN_DESCRIPTION_LIST2 * AB_Banking_GetWizardDescrs (AB_BANKING *ab)
GWEN_PLUGIN_DESCRIPTION_LIST2 * AB_Banking_GetDebuggerDescrs (AB_BANKING *ab, const char *pn)


Define Documentation

#define AB_PM_DATADIR   "datadir"

Definition at line 51 of file aqbanking/banking.h.

#define AB_PM_LIBNAME   "aqbanking"

Definition at line 49 of file aqbanking/banking.h.

#define AB_PM_LOCALEDIR   "localedir"

Definition at line 53 of file aqbanking/banking.h.

#define AB_PM_SYSCONFDIR   "sysconfdir"

Definition at line 50 of file aqbanking/banking.h.

#define AB_PM_WIZARDDIR   "wizarddir"

Definition at line 52 of file aqbanking/banking.h.


Generated on Fri Apr 11 03:04:31 2008 for aqbanking by  doxygen 1.5.5