DragonFly On-Line Manual Pages

SGETU8(3)             DragonFly Library Functions Manual             SGETU8(3)

NAME
     sgetu8 - utf-8 library function manual page

SYNOPSIS
     #include <utf-8.h>

     unsigned int
     sgetu8(unsigned int *chars, char *string);

     unsigned int
     utf8sgetc(unsigned int *chars, char *string);

DESCRIPTION
     The sgetu8() function of utf-8 library reads a sequence of one or more
     characters from a UTF-8 formatted string, which it converts to a single
     UTC-4 (Unicode) value.

     utf8sgetc() is a macro which simply gives sgetu8() a name that may be
     more convenient to remember. It is defined in <utf-8.h>.

     The sgetu8() function and the utf8sgetc() macro take two arguments:
     chars, a pointer to an integer for an additional return value, and
     string, which contains the sequence of one or more UTF-8 characters.

RETURN VALUES
     If string is NULL, or if a premature end-of-string condition occurs,
     sgetu8() returns EOF.  If string contains valid UTF-8 codes, sgetu8()
     returns the converted UTC-4 value. Otherwise, it returns UTF8INVALID,
     defined in <utf-8.h>.

     Additionally, if chars is not NULL, sgetu8() will fill it in with the
     number of characters read from string.  This allows you to determine
     where the next UTF-8 encoded character sequence starts in the string.

SEE ALSO
     libutf-8(3), fgetu8(3), fputu8(3), sputu8(3)

     F. Yergeau, UTF-8, a transformation format of Unicode and ISO 10646,
     RFC2044.

     D. Goldsmith, M. Davis, Using Unicode with MIME, RFC1641.

STANDARDS
     ISO 10646-1: 1993 (``Unicode''), RFC 2044: 1996 (``UTF-8''), ANSI
     X3.159-1989 ("ANSI C89").

DIAGNOSTICS
     You should always check the RETURN VALUES against EOF and UTF8INVALID.

AUTHORS
     This manual page was written by G. Adam Stanislav <adam@whizkidtech.net>.

BUGS
     None known.

DragonFly 6.5-DEVELOPMENT        April 1, 1999       DragonFly 6.5-DEVELOPMENT