United States-English |
|
|
HP-UX Reference > Mmbrtowc(3C)HP-UX 11i Version 3: February 2007 |
|
NAMEmbrtowc() — convert a character to a wide-character code (restartable) SYNOPSIS#include <wchar.h> size_t mbrtowc(wchar_t *__restrict pwc, const char *__restrict s, size_t n, mbstate_t *__restrict ps); DESCRIPTIONIf s is a null pointer, the mbrtowc() function is equivalent to the call: mbrtowc(NULL, "", 1, ps) In this case, the values of the arguments pwc and n are ignored. If s is not a null pointer, the mbrtowc() function inspects at most n bytes beginning at the byte pointed to by s to determine the number of bytes needed to complete the next character (including any shift sequences). If the function determines that the next character is completed, it determines the value of the corresponding wide-character and then, if pwc is not a null pointer, stores that value in the object pointed to by pwc. If the corresponding wide-character is the null wide-character, the resulting state described is the initial conversion state. If ps is a null pointer, the mbrtowc() 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. APPLICATION USAGEThe prototype of this function is available to applications if they are:
RETURN VALUEThe mbrtowc() function returns the first of the following that applies:
ERRORSThe mbrtowc() function may fail if:
WARNINGSWith the exception of ASCII characters, the code values of wide characters (type of wchar_t) are specific to the effective locale specified by the LC_CTYPE environment variable. These values may not be compatible with values obtained by specifying other locales that are supported now, or which may be supported in the future. It is recommended that wide character constants and wide string literals (see the C Reference Manual) not be used, and that wide character code values not be stored in files or devices because future standards may dictate changes in the code value assignments of the wide characters. However, wide character constants and wide string literals corresponding to the characters of the ASCII code set can be safely used since their values are guaranteed to be the same as their ASCII code set values. |
Printable version | ||
|