---

value.h File Reference

HBCI::Value and its C wrapper HBCI_Value. More...

#include <string>

Go to the source code of this file.

Namespaces
namespace	HBCI
Typedefs
typedef HBCI::Value	HBCI_Value
Functions
HBCI_Value *	HBCI_Value_new_double (double value, const char *currency)
int	HBCI_Value_isValid (const HBCI_Value *v)
double	HBCI_Value_getValue (const HBCI_Value *v)
const char *	HBCI_Value_getCurrency (const HBCI_Value *v)
char *	HBCI_Value_toReadableString (const HBCI_Value *v)

---

Detailed Description

HBCI::Value and its C wrapper HBCI_Value.

---

Typedef Documentation

typedef struct HBCI::Value HBCI_Value

---

Function Documentation

const char* HBCI_Value_getCurrency (  const HBCI_Value *    v )

Returns the currency of this value as ISO-4217 string. Returns : The currency. This string is still owned by this object, so don't free it.

double HBCI_Value_getValue (  const HBCI_Value *    v )

Returns the amount of this value. Returns : The amount.

int HBCI_Value_isValid (  const HBCI_Value *    v )

Check whether this value is an empty value, which occurs if it has been constructed by the default empty constructor. Returns true otherwise. Returns : false if invalid/empty value, true if valid value.

HBCI_Value* HBCI_Value_new_double (  double    value, const char *    currency )

Construct a value by giving an amount and a currency. Parameters: value  the amount currency  the currency as ISO-4217 string, e.g. "EUR" for Euro

char* HBCI_Value_toReadableString (  const HBCI_Value *    v )

Returns a user-readable string representation of this value. This has the format e.g. "1234.56 EUR". Returns : The string representation. This Char* buffer will be owned by the caller, so you need to free it by yourself if no longer needed.

---