NAME<\/a> Text::Iconv \u2212 Perl interface to iconv() codeset conversion function<\/p>\n use Text::Iconv; The Text::Iconv<\/b> module provides a Perl interface to the iconv()<\/b> function as defined by the Single UNIX<\/small> Specification.<\/p>\n The convert()<\/b> method converts the encoding of characters in the input string from the fromcode<\/i> codeset to the tocode<\/i> codeset, and returns the result.<\/p>\n Settings of fromcode<\/i> and tocode<\/i> and their permitted combinations are implementation-dependent. Valid values are specified in the system documentation; the iconv<\/b>(1) utility should also provide a \u2212l<\/b> option that lists all supported codesets.<\/p>\n Utility methods retval()<\/b> returns the return value of the underlying iconv()<\/b> function for the last conversion; according to the Single UNIX<\/small> Specification, this value indicates “the number of non-identical conversions performed.” Note, however, that iconv implementations vary widely in the interpretation of this specification.<\/p>\n This method can be called after calling convert()<\/b>, e.g.:<\/p>\n $result = $converter\u2212>convert(“lorem ipsum dolor sit amet”); When called before the first call to convert()<\/b>, or if an error occured during the conversion, retval()<\/b> returns undef<\/b>.<\/p>\n get_attr()<\/b>: This method is only available with GNU<\/small> libiconv, otherwise it throws an exception. The get_attr()<\/b> method allows you to query various attributes which influence the behavior of convert()<\/b>. The currently supported attributes are trivialp<\/i>, transliterate<\/i>, and discard_ilseq<\/i>, e.g.:<\/p>\n $state = $converter\u2212>get_attr(“transliterate”);<\/p>\n See iconvctl<\/b>(3) for details. To ensure portability to other iconv implementations you should first check for the availability of this method using eval {}<\/b>, e.g.:<\/p>\n eval { $conv\u2212>get_attr(“trivialp”) }; This method should be considered experimental.<\/p>\n set_attr()<\/b>: This method is only available with GNU<\/small> libiconv, otherwise it throws an exception. The set_attr()<\/b> method allows you to set various attributes which influence the behavior of convert()<\/b>. The currently supported attributes are transliterate<\/i> and discard_ilseq<\/i>, e.g.:<\/p>\n $state = $converter\u2212>set_attr(“transliterate”);<\/p>\n See iconvctl<\/b>(3) for details. To ensure portability to other iconv implementations you should first check for the availability of this method using eval {}<\/b>, cf. the description of set_attr()<\/b> above.<\/p>\n This method should be considered experimental.<\/p>\n If the conversion can\u2019t be initialized an exception is raised (using croak()<\/b>).<\/p>\n Handling of conversion errors<\/b> Text::Iconv\u2212>raise_error(1); # Conversion errors raise exceptions Per-object handling of conversion errors<\/b> Consult iconv<\/b>(3) for details on errors that might occur.<\/p>\n Conversion of undef<\/b> $converted = $converter\u2212>convert(undef);<\/p>\n always returns undef<\/b>. This is not considered an error.<\/p>\n The supported codesets, their names, the supported conversions, and the quality of the conversions are all system-dependent.<\/p>\n
SYNOPSIS<\/a>
DESCRIPTION<\/a>
ERRORS<\/a>
NOTES<\/a>
AUTHOR<\/a>
SEE ALSO<\/a> <\/p>\n
\nNAME <\/a> <\/h2>\n
SYNOPSIS <\/a> <\/h2>\n
$converter = Text::Iconv\u2212>new(“fromcode”, “tocode”);
$converted = $converter\u2212>convert(“Text to convert”);<\/p>\nDESCRIPTION <\/a> <\/h2>\n
Text::Iconv<\/b> objects also provide the following methods:<\/p>\n
$retval = $converter\u2212>retval;<\/p>\n
if ($@)
{
# get_attr() is not available
}
else
{
# get_attr() is available
}<\/p>\nERRORS <\/a> <\/h2>\n
Text::Iconv<\/i> provides a class attribute raise_error<\/b> and a corresponding class method for setting and getting its value. The handling of errors during conversion depends on the setting of this attribute. If raise_error<\/b> is set to a true value, an exception is raised; otherwise, the convert()<\/b> method only returns undef<\/b>. By default raise_error<\/b> is false. Example usage:<\/p>\n
Text::Iconv\u2212>raise_error(0); # Conversion errors return undef
$a = Text::Iconv\u2212>raise_error(); # Get current setting<\/p>\n
As an experimental feature, Text::Iconv<\/i> also provides an instance attribute raise_error<\/b> and a corresponding method for setting and getting its value. If raise_error<\/b> is undef<\/b>, the class-wide settings apply. If raise_error<\/b> is 1 or 0 (true or false), the object settings override the class-wide settings.<\/p>\n
Converting undef<\/b>, e.g.,<\/p>\nNOTES <\/a> <\/h2>\n
AUTHOR <\/a> <\/h2>\n