mbstowcs(3c) [sunos man page]
mbstowcs(3C) Standard C Library Functions mbstowcs(3C) NAME
mbstowcs - convert a character string to a wide-character string SYNOPSIS
#include <stdlib.h> size_t mbstowcs(wchar_t *restrict pwcs, const char *restrict s, size_t n); DESCRIPTION
The mbstowcs() function converts a sequence of characters from the array pointed to by s into a sequence of corresponding wide-character codes and stores not more than n wide-character codes into the array pointed to by pwcs. No characters that follow a null byte (which is converted into a wide-character code with value 0) will be examined or converted. Each character is converted as if by a call to mbtowc(3C). No more than n elements will be modified in the array pointed to by pwcs. If copying takes place between objects that overlap, the behavior is undefined. The behavior of this function is affected by the LC_CTYPE category of the current locale. If pwcs is a null pointer, mbstowcs() returns the length required to convert the entire array regardless of the value of n, but no values are stored. RETURN VALUES
If an invalid character is encountered, mbstowcs() returns (size_t)-1 and may set errno to indicate the error. Otherwise, mbstowcs() returns the number of the array elements modified (or required if pwcs is NULL), not including a terminating 0 code, if any. The array will not be zero-terminated if the value returned is n. ERRORS
The mbstowcs() function may fail if: EILSEQ Invalid byte sequence is detected. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |CSI |Enabled | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
mblen(3C), mbtowc(3C), setlocale(3C), wcstombs(3C), wctomb(3C), attributes(5), standards(5) SunOS 5.10 1 Nov 2003 mbstowcs(3C)
Check Out this Related Man Page
mbtowc(3C) Standard C Library Functions mbtowc(3C) NAME
mbtowc - convert a character to a wide-character code SYNOPSIS
#include <stdlib.h> int mbtowc(wchar_t *restrict pwc, const char *restrict s, size_t n); DESCRIPTION
If s is not a null pointer, mbtowc() determines the number of the bytes that constitute the character pointed to by s. It then determines the wide-character code for the value of type wchar_t that corresponds to that character. (The value of the wide-character code correspond- ing to the null byte is 0.) If the character is valid and pwc is not a null pointer, mbtowc() stores the wide-character code in the object pointed to by pwc. A call with s as a null pointer causes this function to return 0. The behavior of this function is affected by the LC_CTYPE category of the current locale. At most n bytes of the array pointed to by s will be examined. RETURN VALUES
If s is a null pointer, mbtowc() returns 0. If s is not a null pointer, mbtowc() returns 0 (if s points to the null byte), the number of bytes that constitute the converted character (if the next n or fewer bytes form a valid character), or -1 and may set errno to indicate the error (if they do not form a valid character). In no case will the value returned be greater than n or the value of the MB_CUR_MAX macro. ERRORS
The mbtowc() function may fail if: EILSEQ Invalid character sequence is detected. USAGE
The mbtowc() function can be used safely in multithreaded applications, as long as setlocale(3C) is not being called to change the locale. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ |ATTRIBUTE TYPE |ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |CSI |Enabled | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe with exceptions | +-----------------------------+-----------------------------+ SEE ALSO
mblen(3C), mbstowcs(3C), setlocale(3C), wcstombs(3C), wctomb(3C), attributes(5), standards(5) SunOS 5.11 1 Nov 2003 mbtowc(3C)