---

HBCI_User functions

C wrapper for list of Users
typedef void *(*	list_HBCI_User_cb )(const HBCI_User *user, void *user_data)
void	list_HBCI_User_delete (list_HBCI_User *l)
void	list_HBCI_User_iter_delete (list_HBCI_User_iter *l)
int	list_HBCI_User_size (const list_HBCI_User *l)
list_HBCI_User_iter *	list_HBCI_User_begin (const list_HBCI_User *l)
list_HBCI_User_iter *	list_HBCI_User_end (const list_HBCI_User *l)
const HBCI_User *	list_HBCI_User_iter_get (const list_HBCI_User_iter *l)
void	list_HBCI_User_iter_next (list_HBCI_User_iter *l)
int	list_HBCI_User_iter_equal (const list_HBCI_User_iter *l1, const list_HBCI_User_iter *l2)
void *	list_HBCI_User_foreach (const list_HBCI_User *list, list_HBCI_User_cb func, void *user_data)
HBCI_User identification
const char *	HBCI_User_userId (const HBCI_User *h)
const char *	HBCI_User_userName (const HBCI_User *h)
void	HBCI_User_setUserName (HBCI_User *h, const char *n)
HBCI_User Relation to other objects
const HBCI_Medium *	HBCI_User_medium (const HBCI_User *h)
const HBCI_Bank *	HBCI_User_bank (const HBCI_User *h)
const list_HBCI_Customer *	HBCI_User_customers (const HBCI_User *h)
const HBCI_Customer *	HBCI_User_findCustomer (const HBCI_User *h, const char *custId)
HBCI_Error *	HBCI_User_addCustomer (HBCI_User *h, HBCI_Customer *cust, int autoDelete)
Typedefs
typedef HBCI::User	HBCI_User
	The C accessible type of HBCI::User .
typedef list< HBCI::Pointer< HBCI::User > >	list_HBCI_User
typedef list< HBCI::Pointer< HBCI::User > >::const_iterator	list_HBCI_User_iter

---

Typedef Documentation

typedef struct HBCI::User HBCI_User

The C accessible type of HBCI::User .

typedef list<HBCI::Pointer<HBCI::User> > list_HBCI_User

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

Callback function for list_HBCI_User_foreach.

typedef list<HBCI::Pointer<HBCI::User> >::const_iterator list_HBCI_User_iter

---

Function Documentation

HBCI_Error* HBCI_User_addCustomer (  HBCI_User *    h, HBCI_Customer *    cust, int    autoDelete )

Adds a customer to the list of customers that belong to this user. Parameters: h  The object to perform this action on. cust  The customer to add. autoDelete  If autoDelete==1 (TRUE), this HBCI_User will also take ownership of the Customer and auto-delete the customer if it is being deleted itself. Returns : NULL on success, and the HBCI_Error on failure.

const HBCI_Bank* HBCI_User_bank (  const HBCI_User *    h )

Returns a pointer to the bank that this user belongs to. Parameters: h  The object to perform this action on.

const list_HBCI_Customer* HBCI_User_customers (  const HBCI_User *    h )

Returns a reference to the list of customers. Each customer is a "role" that this user may take during talking to his bank. Parameters: h  The object to perform this action on.

const HBCI_Customer* HBCI_User_findCustomer (  const HBCI_User *    h, const char *    custId )

Searches for the given customer. No wildcards or joker allowed. Author: Martin Preuss<openhbci@aquamaniac.de> Parameters: h  The object to perform this action on. custId  customer id to look for

const HBCI_Medium* HBCI_User_medium (  const HBCI_User *    h )

Medium that this user owns. Returns a pointer to the secure medium that this user uses to authenticate him/herself. Parameters: h  The object to perform this action on.

void HBCI_User_setUserName (  HBCI_User *    h, const char *    n )

Set the clear-text name of this user. This is not set by the bank; instead, this can be set by the application to any arbitrary string that is considered to be helpful in identifiying this user. Parameters: h  The object to perform this action on. n  The user name.

const char* HBCI_User_userId (  const HBCI_User *    h )

The user ID that identifies this user to his bank. Usually this string is assigned to the user by the bank. Parameters: h  The object to perform this action on.

const char* HBCI_User_userName (  const HBCI_User *    h )

Returns the clear-text name of this user. This is not set by the bank; instead, this can be set by the application to any arbitrary string that is considered to be helpful in identifiying this user. Parameters: h  The object to perform this action on.

list_HBCI_User_iter* list_HBCI_User_begin (  const list_HBCI_User *    l )

void list_HBCI_User_delete (  list_HBCI_User *    l )

list_HBCI_User_iter* list_HBCI_User_end (  const list_HBCI_User *    l )

void* list_HBCI_User_foreach (  const list_HBCI_User *    list, list_HBCI_User_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: list  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>

void list_HBCI_User_iter_delete (  list_HBCI_User_iter *    l )

int list_HBCI_User_iter_equal (  const list_HBCI_User_iter *    l1, const list_HBCI_User_iter *    l2 )

const HBCI_User* list_HBCI_User_iter_get (  const list_HBCI_User_iter *    l )

void list_HBCI_User_iter_next (  list_HBCI_User_iter *    l )

int list_HBCI_User_size (  const list_HBCI_User *    l )

---