---

interactorcb.h File Reference

Callback-using HBCI::InteractorCB, intended to be used from C wrapper HBCI_InteractorCB. More...

#include <openhbci/dllimport.h>
#include <openhbci/pointer.h>
#include <openhbci/user.h>
#include <openhbci/interactor.h>

Go to the source code of this file.

Namespaces
namespace	HBCI
Typedefs
typedef int(*	InputPinFuncTyp )(const HBCI_User *user, char **pin, int minsize, int newPin, void *user_data)
typedef int(*	InputUserFuncTyp )(const HBCI_User *user, MediumType type, void *user_data)
typedef void(*	LoggingFuncTyp )(const char *msg, void *user_data)
typedef int(*	BoolFuncTyp )(void *user_data)
typedef void(*	VoidFuncTyp )(void *user_data)
typedef void(*	VoidUserFuncTyp )(const HBCI_User *user, void *user_data)
typedef HBCI::InteractorCB	HBCI_InteractorCB
Functions
HBCI_InteractorCB *	HBCI_InteractorCB_new2 (VoidFuncTyp destrCB, InputPinFuncTyp msgInputPinCB, InputUserFuncTyp msgInsertMediumOrAbortCB, InputUserFuncTyp msgInsertCorrectMediumOrAbortCB, LoggingFuncTyp msgStateResponseCB, BoolFuncTyp keepAliveCB, VoidUserFuncTyp msgStartInputPinViaKeypadCB, VoidUserFuncTyp msgFinishedInputPinViaKeypadCB, void *user_data)
HBCI_InteractorCB *	HBCI_InteractorCB_new (VoidFuncTyp destrCB, InputPinFuncTyp msgInputPinCB, InputUserFuncTyp msgInsertMediumOrAbortCB, InputUserFuncTyp msgInsertCorrectMediumOrAbortCB, LoggingFuncTyp msgStateResponseCB, BoolFuncTyp keepAliveCB, void *user_data)
HBCI_Interactor *	HBCI_InteractorCB_Interactor (HBCI_InteractorCB *h)

---

Detailed Description

Callback-using HBCI::InteractorCB, intended to be used from C wrapper HBCI_InteractorCB.

---

Typedef Documentation

typedef int(* BoolFuncTyp)(void *user_data)

Function that simply returns true or false, depending on some state of the system. Parameters: user_data  The arbitrary data given in the class constructor.

typedef struct HBCI::InteractorCB HBCI_InteractorCB

typedef int(* InputPinFuncTyp)(const HBCI_User *user, char **pin, int minsize, int newPin, void *user_data)

Function to ask the user for the pin (password) of a security medium. Returns : true (!=0) if ok, false (==0) if the user aborted Parameters: user  user for whom the pin is to be asked for. Please note that this pointer may be zero. pin  pointer to a char* pointer that should be set to point to the buffer with the entered pin/password. This entered pin/password buffer is going to be free'd by this class immediately, so don't pass a pointer to some static buffer. minsize  Minimum size of the pin, otherwise it will not be accepted and the calling OpenHBCI function behaves just as if the user aborted this dialog. newPin  if true then the user should be asked for a new pin (i.e. the pin should be entered twice). user_data  The arbitrary data given in the class constructor.

typedef int(* InputUserFuncTyp)(const HBCI_User *user, MediumType type, void *user_data)

Function to tell a user something, and depending on the user's reaction return true or false. Parameters: user  user for whom this function is called. Please note that this pointer may be zero. type  The type of this medium. user_data  The arbitrary data given in the class constructor. Returns : true if ok, false if user wants to abort.

typedef void(* LoggingFuncTyp)(const char *msg, void *user_data)

Function to log a message string. Parameters: msg  The message string to be logged. user_data  The arbitrary data given in the class constructor.

typedef void(* VoidFuncTyp)(void *user_data)

Function that only notifies the application of some event. Parameters: user_data  The arbitrary data given in the class constructor.

typedef void(* VoidUserFuncTyp)(const HBCI_User *user, void *user_data)

Function that notifies of something which is related to the given HBCI_User. Parameters: user  user for whom this function is called. Please note that this pointer may be zero. user_data  The arbitrary data given in the class constructor.

---

Function Documentation

HBCI_Interactor* HBCI_InteractorCB_Interactor (  HBCI_InteractorCB *    h )

Upcast.

HBCI_InteractorCB* HBCI_InteractorCB_new (  VoidFuncTyp    destrCB, InputPinFuncTyp    msgInputPinCB, InputUserFuncTyp    msgInsertMediumOrAbortCB, InputUserFuncTyp    msgInsertCorrectMediumOrAbortCB, LoggingFuncTyp    msgStateResponseCB, BoolFuncTyp    keepAliveCB, void *    user_data )

Old Constructor. DEPRECATED. Rather use HBCI_InteractorCB_new2.

HBCI_InteractorCB* HBCI_InteractorCB_new2 (  VoidFuncTyp    destrCB, InputPinFuncTyp    msgInputPinCB, InputUserFuncTyp    msgInsertMediumOrAbortCB, InputUserFuncTyp    msgInsertCorrectMediumOrAbortCB, LoggingFuncTyp    msgStateResponseCB, BoolFuncTyp    keepAliveCB, VoidUserFuncTyp    msgStartInputPinViaKeypadCB, VoidUserFuncTyp    msgFinishedInputPinViaKeypadCB, void *    user_data )

Constructor since OpenHBCI 0.9.5. See InteractorCB::InteractorCB(). (Old constructor is still around to not break the compile.)

---