1Locale::Currency(3)   User Contributed Perl Documentation  Locale::Currency(3)
2
3
4

NAME

6       Locale::Currency - module for dealing with currency code sets
7

SYNOPSIS

9          use Locale::Currency;
10
11          $name = code2currency(CODE);
12          $code = currency2code(NAME);
13
14          @codes   = all_currency_codes();
15          @names   = all_currency_names();
16

DESCRIPTION

18       This module provides access to currency code sets.
19
20       Please refer to the Locale::Codes::Types document for a description of
21       the code sets available.
22
23       Most of the routines take an optional additional argument which
24       specifies the code set to use. The code set can be specified using the
25       name of a code set, or the perl constant specified in the above
26       document.  If not specified, the default code set will be used.
27

ROUTINES

29       All routines in this module call the appropriate method in the
30       Locale::Codes module, using an object of type: currency Please refer to
31       the documentation of the Locale::Codes module for details about each
32       function.
33
34       The following functions are exported automatically:
35
36       code2currency(CODE [,CODESET] [,'retired'])
37           See code2name in Locale::Codes
38
39       code2currencys(CODE [,CODESET])
40           See code2names in Locale::Codes
41
42       currency2code(NAME [,CODESET] [,'retired'])
43           See name2code in Locale::Codes
44
45       currency_code2code(CODE ,CODESET ,CODESET2)
46           See code2code in Locale::Codes
47
48       all_currency_codes([CODESET] [,'retired'])
49           See all_codes in Locale::Codes
50
51       all_currency_names([CODESET] [,'retired'])
52           See all_names in Locale::Codes
53
54       The following functions are not exported and must be called fully
55       qualified with the package name:
56
57       Locale::Currency::show_errors(FLAG)
58           By default, invalid input will produce empty results, but no
59           errors.  By passing in a non-zero value of FLAG, errors will be
60           produced.
61
62           See show_errors in Locale::Codes but note that the default for the
63           non-OO modules are to NOT produce errors.
64
65       Locale::Currency::rename_currency(CODE ,NEW_NAME [,CODESET])
66           See rename_code in Locale::Codes
67
68       Locale::Currency::add_currency(CODE ,NAME [,CODESET])
69           See add_code in Locale::Codes
70
71       Locale::Currency::delete_currency(CODE [,CODESET])
72           See delete_code in Locale::Codes
73
74       Locale::Currency::add_currency_alias(NAME ,NEW_NAME)
75           See add_alias in Locale::Codes
76
77       Locale::Currency::delete_currency_alias(NAME)
78           See delete_alias in Locale::Codes
79
80       Locale::Currency::rename_currency_code(CODE ,NEW_CODE [,CODESET])
81           See replace_code in Locale::Codes
82
83       Locale::Currency::add_currency_code_alias(CODE ,NEW_CODE [,CODESET])
84           See add_code_alias in Locale::Codes
85
86       Locale::Currency::delete_currency_code_alias(CODE [,CODESET])
87           See delete_code_alias in Locale::Codes
88

SEE ALSO

90       Locale::Codes
91           The Locale-Codes distribution.
92

AUTHOR

94       See Locale::Codes for full author history.
95
96       Currently maintained by Sullivan Beck (sbeck@cpan.org).
97

99          Copyright (c) 2011-2023 Sullivan Beck
100
101       This module is free software; you can redistribute it and/or modify it
102       under the same terms as Perl itself.
103
104
105
106perl v5.38.0                      2023-07-20               Locale::Currency(3)
Impressum