← Back to branch summary

~ubuntu-branches/ubuntu/natty/libextractor/natty

« back to all changes in this revision

Viewing changes to doc/extractor.texi

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Baumann
  • Date: 2009-11-17 20:27:32 UTC
  • mfrom: (1.10.4 upstream) (5.2.5 sid)
  • Revision ID: james.westby@ubuntu.com-20091117202732-ipm2h3gks5bdw2vx
Tags: 0.5.23+dfsg-3
* Building against libltdl7.
* Updating to standards version 3.8.3.
* Adding maintainer homepage field to control.
* Marking maintainer homepage field to be also included in binary
  packages and changelog.
* Adding README.source.
* Simplifying autotools handling in rules.
* Updating README.source.
* Moving maintainer homepage field from control to copyright.
* Dropping la files.
* Simplyfing debhelper install files.
* Bumping versioned build-depends on debhelper.
* Adding depends to dpkg install info.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/extractor.texi
648
648
 
649
649
@cindex UTF-8
650
650
@cindex character set
651
 
@findex convertToUtf8
 
651
@findex EXTRACTOR_common_convert_to_utf8
652
652
Various @acronym{libextractor} plugins make use of the internal
653
653
@file{convert.h} header which defines a function
654
 
@verb{|convertToUtf8|} which can be used to easily convert text from
 
654
@verb{|EXTRACTOR_common_convert_to_utf8|} which can be used to easily convert text from
655
655
any character set to UTF-8.  This conversion is important since the
656
656
linked list of keywords that is returned by @acronym{libextractor} is
657
657
expected to contain only UTF-8 strings.  Naturally, proper conversion
659
659
character set.  In that case, it is often better to not convert at
660
660
all.
661
661
 
662
 
The arguments to @verb{|convertToUtf8|} are the input string (which
 
662
The arguments to @verb{|EXTRACTOR_common_convert_to_utf8|} are the input string (which
663
663
does @emph{not} have to be zero-terminated), the length of the input
664
664
string, and the character set (which @emph{must} be zero-terminated).
665
665
Which character sets are supported depends on the platform, a list can
666
666
generally be obtained using the @command{iconv -l} command.  The
667
 
return value from @verb{|convertToUtf8|} is a zero-terminated string
 
667
return value from @verb{|EXTRACTOR_common_convert_to_utf8|} is a zero-terminated string
668
668
in UTF-8 format.  The responsibility to free the string is with the
669
669
caller, so storing the string in the keyword list is acceptable.
670
670