diff options
author | Florian Dold <florian.dold@gmail.com> | 2020-01-19 22:01:20 +0100 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2020-01-19 22:01:27 +0100 |
commit | 12468e1fd89748aaa4b1d31052e97e2436b763c4 (patch) | |
tree | 31c0e9f0ccba2686f0fff878c1c8266c2efdacad /src/include | |
parent | a4cfbf3471c10a0bcb5376f390d1021880d4943a (diff) | |
download | exchange-12468e1fd89748aaa4b1d31052e97e2436b763c4.tar.xz |
denom->amount
Diffstat (limited to 'src/include')
-rw-r--r-- | src/include/taler_amount_lib.h | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/src/include/taler_amount_lib.h b/src/include/taler_amount_lib.h index e3f39cbb7..f088d89b4 100644 --- a/src/include/taler_amount_lib.h +++ b/src/include/taler_amount_lib.h @@ -113,42 +113,43 @@ struct TALER_Amount /** - * Parse denomination description, in the format "T:V.F". + * Parse monetary amount, in the format "T:V.F". * - * @param str denomination description - * @param[out] denom denomination to write the result to - * @return #GNUNET_OK if the string is a valid denomination specification, + * @param str amount string + * @param[out] amount amount to write the result to + * @return #GNUNET_OK if the string is a valid monetary amount specification, * #GNUNET_SYSERR if it is invalid. */ int TALER_string_to_amount (const char *str, - struct TALER_Amount *denom); + struct TALER_Amount *amount); /** - * Parse denomination description, in the format "T:V.F". + * Parse monetary amount, in the format "T:V.F". + * The result is stored in network byte order (NBO). * - * @param str denomination description - * @param[out] denom denomination to write the result to, in NBO - * @return #GNUNET_OK if the string is a valid denomination specification, + * @param str amount string + * @param[out] amount_nbo amount to write the result to + * @return #GNUNET_OK if the string is a valid amount specification, * #GNUNET_SYSERR if it is invalid. */ int TALER_string_to_amount_nbo (const char *str, - struct TALER_AmountNBO *denom); + struct TALER_AmountNBO *amount_nbo); /** * Get the value of "zero" in a particular currency. * * @param cur currency description - * @param[out] denom denomination to write the result to + * @param[out] amount amount to write the result to * @return #GNUNET_OK if @a cur is a valid currency specification, * #GNUNET_SYSERR if it is invalid. */ int TALER_amount_get_zero (const char *cur, - struct TALER_Amount *denom); + struct TALER_Amount *amount); /** |