mbstowcs
- Updated2023-02-21
- 1 minute(s) read
mbstowcs
size_t mbstowcs (wchar_t *wideCharCodes, const char multibyteString[], size_t codeLimit);
Purpose
Converts a sequence of multibyte characters into their corresponding wide character codes, storing only a specified number of codes. No multibyte characters are converted beyond the null character.
Parameters
| Input | ||
| Name | Type | Description |
| multibyteString | const char [] | Contains a string of multibyte codes that are converted to their corresponding wide character codes. No multibyte characters that follow a null character are examined or converted. |
| codeLimit | size_t | Specifies the maximum number of codes that are stored. This value also specifies the maximum number of elements of wideCharCodes that are modified. |
| Output | ||
| Name | Type | Description |
| wideCharCodes | wchar_t | Contains the array of wide character codes corresponding to the multibyte characters in multibyteString. At most, codeLimit codes are stored. |
Return Value
| Name | Type | Description |
| ElementsModified | size_t | Contains the number of array elements modified, not including a terminating zero code, if any. If an invalid multibyte character is encountered, the value -1 is returned. |
Additional Information
Library: ANSI C Library
Include file: ansi_c.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later