The ifx_gl_mbstowcs() function

Syntax

#include <ifxgls.h>
...
int ifx_gl_mbstowcs(wcs, mbs, mbs_byte_length, char_limit)
       gl_wchar_t *wcs;
       gl_mchar_t *mbs;
       int mbs_byte_length;
       int char_limit;

wcs

A pointer to the wide-character string that contains the wide-character equivalent of mbs.

mbs

A pointer to the multibyte-character string to convert to the wcs wide-character string.

mbs_byte_length

The integer number of bytes in the mbs string. If mbs_byte_length is the value IFX_GL_NULL, the function assumes that mbs is a null-terminated string.

char_limit

The maximum number of multibyte characters to read from mbs.

Usage

The ifx_gl_mbstowcs() function converts mbs into its wide-character representation and stores the result in the location that wcs references. The function reads no more than char_limit characters from mbs and writes them to wcs.

If mbs_byte_length is equal to IFX_GL_NULL, the function null-terminates the string in wcs. Any other value of mbs_byte_length means that the function does not null-terminate the resulting wide-character string.

Return values

>=0

The number of characters read from mbs and written to wcs, not counting any null terminator.

-1

The function was not successful, and the error number is set to indicate the cause. See the Errors section.

Errors