Click above to get retro games delivered to your door ever month!

Synopsis:
    #include <stdlib.h>
    int mbtowc( wchar_t *pwc, const char *s, size_t n );

Description:
    The mbtowc function converts a single multibyte character pointed to by
    s into the wide character code that corresponds to that multibyte
    character.  The code for the null character is zero.  If the multibyte
    character is valid and pwc is not a NULL pointer, the code is stored in
    the object pointed to by pwc.  At most n bytes of the array pointed to
    by s will be examined.

Returns:
    If s is a NULL pointer, the mbtowc function returns zero if multibyte
    character encodings do not have state-dependent encoding, and non-zero
    otherwise.  If s is not a NULL pointer, the mbtowc function returns:

    0
        if s points to the null character

    len
        the number of bytes that comprise the multibyte character (if the
        next n or fewer bytes form a valid multibyte character)

    -1
        if the next n bytes do not form a valid multibyte character


See Also:
    mblen, wctomb, mbstowcs, wcstombs

Example:
    #include <stdio.h>
    #include <stdlib.h>

    void main()
      {
        char    *wc = "string";
        wchar_t wbuffer[10];
        int     i, len;

        printf( "Character encodings do %shave "
                "state-dependent encoding\n",
                ( mbtowc( wbuffer, NULL, 0 ) )
                ? "" : "not " );

        len = mbtowc( wbuffer, wc, 2 );
        wbuffer[len] = '\0';
        printf( "%s(%d)\n", wc, len );
        for( i = 0; i < len; i++ )
            printf( "/%4.4x", wbuffer[i] );
        printf( "\n" );
      }

    produces the following:

    Character encodings do not have state-dependent encoding
    string(1)
    /0073

Classification:
    ANSI

Systems:
    All