---

HBCI_OutboxJob and derivations

HBCI_OutboxJobGetBalance
HBCI_OutboxJobGetBalance *	HBCI_OutboxJobGetBalance_new (const HBCI_Customer *c, HBCI_Account *a)
HBCI_OutboxJob *	HBCI_OutboxJobGetBalance_OutboxJob (HBCI_OutboxJobGetBalance *j)
const HBCI_AccountBalance *	HBCI_OutboxJobGetBalance_getBalance (const HBCI_OutboxJobGetBalance *j)
HBCI_OutboxJobGetTransactions
HBCI_OutboxJobGetTransactions *	HBCI_OutboxJobGetTransactions_new (const HBCI_Customer *c, HBCI_Account *a, const HBCI_Date *fromdate, const HBCI_Date *todate)
HBCI_OutboxJob *	HBCI_OutboxJobGetTransactions_OutboxJob (HBCI_OutboxJobGetTransactions *j)
const list_HBCI_Transaction *	HBCI_OutboxJobGetTransactions_transactions (const HBCI_OutboxJobGetTransactions *j)
const HBCI_Balance *	HBCI_OutboxJobGetTransactions_lastBalance (const HBCI_OutboxJobGetTransactions *j)
HBCI_OutboxJobTransfer
HBCI_OutboxJobTransfer *	HBCI_OutboxJobTransfer_new (const HBCI_Customer *c, HBCI_Account *a, const HBCI_Transaction *trans)
HBCI_OutboxJob *	HBCI_OutboxJobTransfer_OutboxJob (HBCI_OutboxJobTransfer *j)
HBCI_OutboxJobDebitNote
HBCI_OutboxJobDebitNote *	HBCI_OutboxJobDebitNote_new (const HBCI_Customer *c, HBCI_Account *a, const HBCI_Transaction *trans)
HBCI_OutboxJob *	HBCI_OutboxJobDebitNote_OutboxJob (HBCI_OutboxJobDebitNote *j)
HBCI_OutboxJob
void	HBCI_OutboxJob_delete (HBCI_OutboxJob *j)
void	HBCI_OutboxJob_addSigner (HBCI_OutboxJob *j, const HBCI_Customer *c)
OutboxJob_Status	HBCI_OutboxJob_status (const HBCI_OutboxJob *j)
OutboxJob_Result	HBCI_OutboxJob_result (const HBCI_OutboxJob *j)
int	HBCI_OutboxJob_id (const HBCI_OutboxJob *j)
list_int *	HBCI_OutboxJob_resultCodes (const HBCI_OutboxJob *j)
const HBCI_MessageReference *	HBCI_OutboxJob_messageReference (const HBCI_OutboxJob *j)
int	HBCI_OutboxJob_segmentForStatusReport (const HBCI_OutboxJob *j)
JobProgressType	HBCI_OutboxJob_type (const HBCI_OutboxJob *j)
HBCI_OutboxJobGetKeys
HBCI_OutboxJobGetKeys *	HBCI_OutboxJobGetKeys_new (const HBCI_API *api, const HBCI_Customer *c)
HBCI_OutboxJob *	HBCI_OutboxJobGetKeys_OutboxJob (HBCI_OutboxJobGetKeys *j)
HBCI_OutboxJobSendKeys
HBCI_OutboxJobSendKeys *	HBCI_OutboxJobSendKeys_new (const HBCI_API *api, const HBCI_Customer *c)
HBCI_OutboxJob *	HBCI_OutboxJobSendKeys_OutboxJob (HBCI_OutboxJobSendKeys *j)
HBCI_OutboxJobDisableKeys
HBCI_OutboxJobDisableKeys *	HBCI_OutboxJobDisableKeys_new (const HBCI_API *api, const HBCI_Customer *c)
HBCI_OutboxJob *	HBCI_OutboxJobDisableKeys_OutboxJob (HBCI_OutboxJobDisableKeys *j)
HBCI_OutboxJobDisableLostKeys
HBCI_OutboxJobDisableLostKeys *	HBCI_OutboxJobDisableLostKeys_new (const HBCI_API *api, const HBCI_Customer *c, int keyNumber, int keyVersion)
HBCI_OutboxJob *	HBCI_OutboxJobDisableLostKeys_OutboxJob (HBCI_OutboxJobDisableLostKeys *j)
HBCI_OutboxJobChangeKeys
HBCI_OutboxJobChangeKeys *	HBCI_OutboxJobChangeKeys_new (const HBCI_API *api, const HBCI_Customer *c)
HBCI_OutboxJob *	HBCI_OutboxJobChangeKeys_OutboxJob (HBCI_OutboxJobChangeKeys *j)
HBCI_OutboxJobGetAccounts
HBCI_OutboxJobGetAccounts *	HBCI_OutboxJobGetAccounts_new (HBCI_Customer *c)
HBCI_OutboxJob *	HBCI_OutboxJobGetAccounts_OutboxJob (HBCI_OutboxJobGetAccounts *j)
HBCI_OutboxJobGetSystemId
HBCI_OutboxJobGetSystemId *	HBCI_OutboxJobGetSystemId_new (const HBCI_API *api, HBCI_Customer *c)
HBCI_OutboxJob *	HBCI_OutboxJobGetSystemId_OutboxJob (HBCI_OutboxJobGetSystemId *j)
HBCI_OutboxJobGetStatusReport
HBCI_OutboxJobGetStatusReports *	HBCI_OutboxJobGetStatusReports_new (HBCI_Customer *c, const HBCI_Date *fromdate, const HBCI_Date *todate, int maxEntries)
HBCI_OutboxJob *	HBCI_OutboxJobGetStatusReports_OutboxJob (HBCI_OutboxJobGetStatusReports *j)
const list_HBCI_StatusReport *	HBCI_OutboxJobGetStatusReports_statusReports (const HBCI_OutboxJobGetStatusReports *j)
	Returns the list of status reports that this job retrieved.
HBCI_OutboxJobGetStOs
HBCI_OutboxJobGetStOs *	HBCI_OutboxJobGetStOs_new (const HBCI_Customer *c, HBCI_Account *a)
HBCI_OutboxJob *	HBCI_OutboxJobGetStOs_OutboxJob (HBCI_OutboxJobGetStOs *j)
const list_HBCI_StO *	HBCI_OutboxJobGetStOs_getOrders (const HBCI_OutboxJobGetStOs *j)
HBCI_OutboxJobNewStO
HBCI_OutboxJobNewStO *	HBCI_OutboxJobNewStO_new (const HBCI_Customer *c, HBCI_Account *a, const HBCI_StandingOrder *sto)
HBCI_OutboxJob *	HBCI_OutboxJobNewStO_OutboxJob (HBCI_OutboxJobNewStO *j)
HBCI_OutboxJobDeleteStO
HBCI_OutboxJobDeleteStO *	HBCI_OutboxJobDeleteStO_new (const HBCI_Customer *c, HBCI_Account *a, const HBCI_StandingOrder *sto)
HBCI_OutboxJob *	HBCI_OutboxJobDeleteStO_OutboxJob (HBCI_OutboxJobDeleteStO *j)
Typedefs
typedef HBCI::OutboxJobGetBalance	HBCI_OutboxJobGetBalance
typedef HBCI::OutboxJobGetTransactions	HBCI_OutboxJobGetTransactions
typedef HBCI::OutboxJobTransfer	HBCI_OutboxJobTransfer
typedef HBCI::OutboxJobDebitNote	HBCI_OutboxJobDebitNote
typedef HBCI::OutboxJob	HBCI_OutboxJob
	C accessible type of HBCI::OutboxJob.
typedef HBCI::OutboxJobGetKeys	HBCI_OutboxJobGetKeys
typedef HBCI::OutboxJobSendKeys	HBCI_OutboxJobSendKeys
typedef HBCI::OutboxJobDisableKeys	HBCI_OutboxJobDisableKeys
typedef HBCI::OutboxJobDisableLostKeys	HBCI_OutboxJobDisableLostKeys
typedef HBCI::OutboxJobChangeKeys	HBCI_OutboxJobChangeKeys
typedef HBCI::OutboxJobGetAccounts	HBCI_OutboxJobGetAccounts
typedef HBCI::OutboxJobSynchronize	HBCI_OutboxJobSynchronize
typedef HBCI::OutboxJobGetSystemId	HBCI_OutboxJobGetSystemId
typedef HBCI::OutboxJobGetStatusReports	HBCI_OutboxJobGetStatusReports
typedef HBCI::OutboxJobGetStandingOrders	HBCI_OutboxJobGetStOs
typedef HBCI::OutboxJobNewStandingOrder	HBCI_OutboxJobNewStO
typedef HBCI::OutboxJobDeleteStandingOrder	HBCI_OutboxJobDeleteStO

---

Typedef Documentation

typedef HBCI::OutboxJob HBCI_OutboxJob

C accessible type of HBCI::OutboxJob.

typedef struct HBCI::OutboxJobChangeKeys HBCI_OutboxJobChangeKeys

typedef struct HBCI::OutboxJobDebitNote HBCI_OutboxJobDebitNote

typedef struct HBCI::OutboxJobDeleteStandingOrder HBCI_OutboxJobDeleteStO

typedef struct HBCI::OutboxJobDisableKeys HBCI_OutboxJobDisableKeys

typedef struct HBCI::OutboxJobDisableLostKeys HBCI_OutboxJobDisableLostKeys

typedef struct HBCI::OutboxJobGetAccounts HBCI_OutboxJobGetAccounts

typedef struct HBCI::OutboxJobGetBalance HBCI_OutboxJobGetBalance

typedef struct HBCI::OutboxJobGetKeys HBCI_OutboxJobGetKeys

typedef struct HBCI::OutboxJobGetStatusReports HBCI_OutboxJobGetStatusReports

typedef struct HBCI::OutboxJobGetStandingOrders HBCI_OutboxJobGetStOs

typedef struct HBCI::OutboxJobGetSystemId HBCI_OutboxJobGetSystemId

typedef struct HBCI::OutboxJobGetTransactions HBCI_OutboxJobGetTransactions

typedef struct HBCI::OutboxJobNewStandingOrder HBCI_OutboxJobNewStO

typedef struct HBCI::OutboxJobSendKeys HBCI_OutboxJobSendKeys

typedef struct HBCI::OutboxJobSynchronize HBCI_OutboxJobSynchronize

typedef struct HBCI::OutboxJobTransfer HBCI_OutboxJobTransfer

---

Function Documentation

void HBCI_OutboxJob_addSigner (  HBCI_OutboxJob *    j, const HBCI_Customer *    c )

Adds a signer. Here you can add a signer. In most cases you don't need this method, since the first signer is already given in the constructor. But you need this method if this job needs multiple signers for your bank.

void HBCI_OutboxJob_delete (  HBCI_OutboxJob *    j )

Destructor

int HBCI_OutboxJob_id (  const HBCI_OutboxJob *    j )

Return the id of this job. Return the id of this job. Each enqueued job has a unique id. This can be used from an application to identify specific jobs after they have been added to the outbox queue.

const HBCI_MessageReference* HBCI_OutboxJob_messageReference (  const HBCI_OutboxJob *    j )

Returns the message reference of this job. This is later used for status reports.

OutboxJob_Result HBCI_OutboxJob_result (  const HBCI_OutboxJob *    j )

Returns the result of this job.

list_int* HBCI_OutboxJob_resultCodes (  const HBCI_OutboxJob *    j )

Returns a list of result codes of this job. This can be used to get more detailed information if the result of this job was HBCI_JOB_RESULT_FAILED. In that case, you can traverse this list, checking for resultcodes >= 9000. Each of those can be the source of the job failure, so you can react accordingly. HBCI spec suggests that the most important of them can be found at the front() already, but that depends on your bank. Note: A resultcode >= 9000 does not automatically mean an error, see MessageQueue::getResult(). See also: MessageQueue::getResult(), Job::errorcodeIsLibraryBug()

int HBCI_OutboxJob_segmentForStatusReport (  const HBCI_OutboxJob *    j )

Returns the number of the segment to be used for status reports. Returns "-1" as default, meaning no segment number (NOTE: In this case the corresponding field in HKPRO will be left out)

OutboxJob_Status HBCI_OutboxJob_status (  const HBCI_OutboxJob *    j )

Returns the status of this job.

JobProgressType HBCI_OutboxJob_type (  const HBCI_OutboxJob *    j )

Return the JobProgressType of this job. Author: Christian Stimming <stimming@tuhh.de>

HBCI_OutboxJobChangeKeys* HBCI_OutboxJobChangeKeys_new (  const HBCI_API *    api, const HBCI_Customer *    c )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobChangeKeys_OutboxJob (  HBCI_OutboxJobChangeKeys *    j )

Upcast

HBCI_OutboxJobDebitNote* HBCI_OutboxJobDebitNote_new (  const HBCI_Customer *    c, HBCI_Account *    a, const HBCI_Transaction *    trans )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobDebitNote_OutboxJob (  HBCI_OutboxJobDebitNote *    j )

Upcast

HBCI_OutboxJobDeleteStO* HBCI_OutboxJobDeleteStO_new (  const HBCI_Customer *    c, HBCI_Account *    a, const HBCI_StandingOrder *    sto )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobDeleteStO_OutboxJob (  HBCI_OutboxJobDeleteStO *    j )

Upcast

HBCI_OutboxJobDisableKeys* HBCI_OutboxJobDisableKeys_new (  const HBCI_API *    api, const HBCI_Customer *    c )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobDisableKeys_OutboxJob (  HBCI_OutboxJobDisableKeys *    j )

Upcast

HBCI_OutboxJobDisableLostKeys* HBCI_OutboxJobDisableLostKeys_new (  const HBCI_API *    api, const HBCI_Customer *    c, int    keyNumber, int    keyVersion )

Constructor. Parameters: api  The HBCI-context c  The owner of the lost keys keyNumber  The number of the key to be disabled. If you don't know the number, use the number "999" here. keyVersion  The version number of the key to be disabled. If you don't know the version number, use the number "999" here.

HBCI_OutboxJob* HBCI_OutboxJobDisableLostKeys_OutboxJob (  HBCI_OutboxJobDisableLostKeys *    j )

Upcast

HBCI_OutboxJobGetAccounts* HBCI_OutboxJobGetAccounts_new (  HBCI_Customer *    c )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobGetAccounts_OutboxJob (  HBCI_OutboxJobGetAccounts *    j )

Upcast

const HBCI_AccountBalance* HBCI_OutboxJobGetBalance_getBalance (  const HBCI_OutboxJobGetBalance *    j )

HBCI_OutboxJobGetBalance* HBCI_OutboxJobGetBalance_new (  const HBCI_Customer *    c, HBCI_Account *    a )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobGetBalance_OutboxJob (  HBCI_OutboxJobGetBalance *    j )

Upcast

HBCI_OutboxJobGetKeys* HBCI_OutboxJobGetKeys_new (  const HBCI_API *    api, const HBCI_Customer *    c )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobGetKeys_OutboxJob (  HBCI_OutboxJobGetKeys *    j )

Upcast

HBCI_OutboxJobGetStatusReports* HBCI_OutboxJobGetStatusReports_new (  HBCI_Customer *    c, const HBCI_Date *    fromdate, const HBCI_Date *    todate, int    maxEntries )

Constructor Parameters: c  Customer that invokes this job. fromdate  date of the first day you want to inspect, if invalid then the first possible date will be used. Please note that some banks NEED this date to be set todate  date of the last day you want to inspect, if invalid then the current date will be used. maxEntries  The maximum number of entries that should be fetched.

HBCI_OutboxJob* HBCI_OutboxJobGetStatusReports_OutboxJob (  HBCI_OutboxJobGetStatusReports *    j )

Upcast

const list_HBCI_StatusReport* HBCI_OutboxJobGetStatusReports_statusReports (  const HBCI_OutboxJobGetStatusReports *    j )

Returns the list of status reports that this job retrieved.

const list_HBCI_StO* HBCI_OutboxJobGetStOs_getOrders (  const HBCI_OutboxJobGetStOs *    j )

Returns the retrieved list of StandingOrders.

HBCI_OutboxJobGetStOs* HBCI_OutboxJobGetStOs_new (  const HBCI_Customer *    c, HBCI_Account *    a )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobGetStOs_OutboxJob (  HBCI_OutboxJobGetStOs *    j )

Upcast

HBCI_OutboxJobGetSystemId* HBCI_OutboxJobGetSystemId_new (  const HBCI_API *    api, HBCI_Customer *    c )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobGetSystemId_OutboxJob (  HBCI_OutboxJobGetSystemId *    j )

Upcast

const HBCI_Balance* HBCI_OutboxJobGetTransactions_lastBalance (  const HBCI_OutboxJobGetTransactions *    j )

HBCI_OutboxJobGetTransactions* HBCI_OutboxJobGetTransactions_new (  const HBCI_Customer *    c, HBCI_Account *    a, const HBCI_Date *    fromdate, const HBCI_Date *    todate )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobGetTransactions_OutboxJob (  HBCI_OutboxJobGetTransactions *    j )

Upcast

const list_HBCI_Transaction* HBCI_OutboxJobGetTransactions_transactions (  const HBCI_OutboxJobGetTransactions *    j )

Returns the list of transactions.

HBCI_OutboxJobNewStO* HBCI_OutboxJobNewStO_new (  const HBCI_Customer *    c, HBCI_Account *    a, const HBCI_StandingOrder *    sto )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobNewStO_OutboxJob (  HBCI_OutboxJobNewStO *    j )

Upcast

HBCI_OutboxJobSendKeys* HBCI_OutboxJobSendKeys_new (  const HBCI_API *    api, const HBCI_Customer *    c )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobSendKeys_OutboxJob (  HBCI_OutboxJobSendKeys *    j )

Upcast

HBCI_OutboxJobTransfer* HBCI_OutboxJobTransfer_new (  const HBCI_Customer *    c, HBCI_Account *    a, const HBCI_Transaction *    trans )

Constructor

HBCI_OutboxJob* HBCI_OutboxJobTransfer_OutboxJob (  HBCI_OutboxJobTransfer *    j )

Upcast

---