wcsrtombs(3c) [hpux man page]
wcsrtombs(3C) wcsrtombs(3C) NAME
wcsrtombs() - convert a wide-character string to a character string (restartable) SYNOPSIS
DESCRIPTION
The function converts a sequence of wide-characters from the array indirectly pointed to by src into a sequence of corresponding charac- ters, beginning in the conversion state described by the object pointed to by ps. If dst is not a null pointer, the converted characters are then stored into the array pointed to by dst. Conversion continues up to and including a terminating null wide-character, which is also stored. Conversion stops earlier in the following cases: o When a code is reached that does not correspond to a valid character. o When the next character would exceed the limit of len total bytes to be stored in the array pointed to by dst (and dst is not a null pointer). Each conversion takes place as if by a call to the function. If dst is not a null pointer, the pointer object pointed to by src is assigned either a null pointer (if conversion stopped due to reaching a terminating null wide-character) or the address just past the last wide-character converted (if any). If conversion stopped due to reaching a terminating null wide-character, the resulting state described is the initial conversion state. If ps is a null pointer, the function uses its own internal object, which is initialized at program startup to the initial conversion state. Otherwise, the object pointed to by ps is used to completely describe the current conversion state of the associated character sequence. The implementation will behave as if no function defined in this specification calls APPLICATION USAGE
The prototype of this function is available to applications if they are: a. conformant. b. Compiled with macro with a value >=500. c. Compiled with macro with a value >= 200112. EXTERNAL INFLUENCES
Environment Variables The behavior of this function is affected by the category of the current locale. RETURN VALUE
If conversion stops because a code is reached that does not correspond to a valid character, an encoding error occurs. In this case, the function stores the value of the macro in and returns (size_t)-1; the conversion state is undefined. Otherwise, it returns the number of bytes in the resulting character sequence, not including the terminating null (if any). ERRORS
The function may fail if: A wide-character code does not correspond to a valid character. ps points to an object that contains an invalid conversion state. AUTHOR
was developed by HP and Mitsubishi Electric Corporation. SEE ALSO
mbsinit(3C), wcrtomb(3C). wcsrtombs(3C)
Check Out this Related Man Page
mbsrtowcs(3C) Standard C Library Functions mbsrtowcs(3C) NAME
mbsrtowcs - convert a character string to a wide-character string (restartable) SYNOPSIS
#include <wchar.h> size_t mbsrtowcs(wchar_t *restrict dst, const char **restrict src, size_t len, mbstate_t *restrict ps); DESCRIPTION
The mbsrtowcs() function converts a sequence of characters, beginning in the conversion state described by the object pointed to by ps, from the array indirectly pointed to by src into a sequence of corresponding wide-characters. If dst is not a null pointer, the converted characters are stored into the array pointed to by dst. Conversion continues up to and including a terminating null character, which is also stored. Conversion stops early in either of the following cases: o When a sequence of bytes is encountered that does not form a valid character. o When len codes have been stored into the array pointed to by dst (and dst is not a null pointer). Each conversion takes place as if by a call to the mbrtowc() function. If dst is not a null pointer, the pointer object pointed to by src is assigned either a null pointer (if conversion stopped due to reaching a terminating null character) or the address just past the last character converted (if any). If conversion stopped due to reaching a ter- minating null character, and if dst is not a null pointer, the resulting state described is the initial conversion state. If ps is a null pointer, the mbsrtowcs() function uses its own internal mbstate_t object, which is initialized at program startup to the initial conversion state. Otherwise, the mbstate_t object pointed to by ps is used to completely describe the current conversion state of the associated character sequence. Solaris will behave as if no function defined in the Solaris Reference Manual calls mbsrtowcs(). The behavior of this function is affected by the LC_CTYPE category of the current locale. See environ(5). RETURN VALUES
If the input conversion encounters a sequence of bytes that do not form a valid character, an encoding error occurs. In this case, the mbsrtowcs() function stores the value of the macro EILSEQ in errno and returns (size_t)-1; the conversion state is undefined. Otherwise, it returns the number of characters successfully converted, not including the terminating null (if any). ERRORS
The mbsrtowcs() function may fail if: EINVAL The ps argument points to an object that contains an invalid conversion state. EILSEQ Invalid character sequence is detected. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |See NOTES below | +-----------------------------+-----------------------------+ SEE ALSO
mbrtowc(3C), mbsinit(3C), setlocale(3C), attributes(5), environ(5), standards(5) NOTES
If ps is not a null pointer, mbsrtowcs() uses the mbstate_t object pointed to by ps and the function can be used safely in multithreaded applications, as long as setlocale(3C) is not being called to change the locale. If ps is a null pointer, mbsrtowcs() uses its internal mbstate_t object and the function is Unsafe in multithreaded applications. SunOS 5.11 1 Nov 2003 mbsrtowcs(3C)