Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

customer.h File Reference

Definitions of HBCI::Customer and its HBCI_Customer C wrapper. More...

#include <string>
#include <list>
#include <openhbci/pointer.h>
#include <openhbci/user.h>

Go to the source code of this file.

Namespaces

namespace  HBCI

C wrapper for list of Customer

typedef void *(* list_HBCI_Customer_cb )(const HBCI_Customer *customer, void *user_data)
void list_HBCI_Customer_delete (list_HBCI_Customer *l)
int list_HBCI_Customer_size (const list_HBCI_Customer *l)
void list_HBCI_Customer_iter_delete (list_HBCI_Customer_iter *l)
list_HBCI_Customer_iterlist_HBCI_Customer_begin (const list_HBCI_Customer *l)
list_HBCI_Customer_iterlist_HBCI_Customer_end (const list_HBCI_Customer *l)
const HBCI_Customerlist_HBCI_Customer_iter_get (const list_HBCI_Customer_iter *l)
void list_HBCI_Customer_iter_next (list_HBCI_Customer_iter *l)
int list_HBCI_Customer_iter_equal (const list_HBCI_Customer_iter *l1, const list_HBCI_Customer_iter *l2)
void * list_HBCI_Customer_foreach (const list_HBCI_Customer *list, list_HBCI_Customer_cb func, void *user_data)

HBCI_Customer methods

const HBCI_UserHBCI_Customer_user (const HBCI_Customer *h)
const char * HBCI_Customer_custId (const HBCI_Customer *h)
const char * HBCI_Customer_custName (const HBCI_Customer *h)
void HBCI_Customer_setCustName (HBCI_Customer *h, const char *n)

Typedefs

typedef HBCI::Customer HBCI_Customer
typedef list< HBCI::Pointer<
HBCI::Customer > > 
list_HBCI_Customer
typedef list< HBCI::Pointer<
HBCI::Customer > >::const_iterator 
list_HBCI_Customer_iter


Detailed Description

Definitions of HBCI::Customer and its HBCI_Customer C wrapper.


Typedef Documentation

typedef struct HBCI::Customer HBCI_Customer
 

typedef list<HBCI::Pointer<HBCI::Customer> > list_HBCI_Customer
 

typedef void*(* list_HBCI_Customer_cb)(const HBCI_Customer *customer, void *user_data)
 

Callback function for list_HBCI_Customer_foreach.

typedef list<HBCI::Pointer<HBCI::Customer> >::const_iterator list_HBCI_Customer_iter
 


Function Documentation

const char* HBCI_Customer_custId const HBCI_Customer   h
 

Returns the customer id assigned to this Customer by the Bank.

The customer ID that identifies this customer to his bank. Usually this string is assigned to the customer by the bank.

Parameters:
h  The object to perform this action on.

const char* HBCI_Customer_custName const HBCI_Customer   h
 

Returns the name of this customer.

Returns the name of the customer, i.e. the role this customer plays. You can choose this name as you like, e.g. "secretary", "private" or whatever you prefer. This member makes it easier for you to distinguish this customers from others, since the raw customer id is quite cryptic in most cases.

Parameters:
h  The object to perform this action on.

void HBCI_Customer_setCustName HBCI_Customer   h,
const char *    n
 

Sets the name of this customer.

Sets the name of this customer, i.e. the role this customer plays. You can set this to any arbitrary string you consider helpful.

Parameters:
h  The object to perform this action on.
n  Sets this to the new name of the customer.

const HBCI_User* HBCI_Customer_user const HBCI_Customer   h
 

Returns a pointer to the User this customer belongs to.

Parameters:
h  The object to perform this action on.

list_HBCI_Customer_iter* list_HBCI_Customer_begin const list_HBCI_Customer   l
 

void list_HBCI_Customer_delete list_HBCI_Customer   l
 

list_HBCI_Customer_iter* list_HBCI_Customer_end const list_HBCI_Customer   l
 

void* list_HBCI_Customer_foreach const list_HBCI_Customer   list,
list_HBCI_Customer_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_Customer_iter_delete list_HBCI_Customer_iter   l
 

int list_HBCI_Customer_iter_equal const list_HBCI_Customer_iter   l1,
const list_HBCI_Customer_iter   l2
 

const HBCI_Customer* list_HBCI_Customer_iter_get const list_HBCI_Customer_iter   l
 

void list_HBCI_Customer_iter_next list_HBCI_Customer_iter   l
 

int list_HBCI_Customer_size const list_HBCI_Customer   l
 


Generated on Mon Jun 23 13:41:08 2003 for openhbci by doxygen1.2.17