MBSINIT(3C) Standard C Library Functions MBSINIT(3C)
NAME
mbsinit,mbsinit_l - determine conversion object status
SYNOPSIS
#include <wchar.h>
int mbsinit(
const mbstate_t *ps);
#include <wchar.h>
#include <xlocale.h>
int mbsinit_l(
const mbstate_t *ps,
locale_t loc);
DESCRIPTION
If
ps is not a null pointer, the
mbsinit() function determines
whether the object pointed to by
ps describes an initial conversion
state.
The function
mbsinit_l() behaves identically to
mbsinit() except the
current locale is ignored and the locale
loc is used instead.
RETURN VALUES
The
mbsinit() function returns non-zero if
ps is a null pointer, or
if the pointed-to object describes an initial conversion state;
otherwise, it returns
0.
If an
mbstate_t object is altered by any of the functions described
as "restartable", and is then used with a different character
sequence, or in the other conversion direction, or with a different
LC_CTYPE category setting than on earlier function calls, the
behavior is undefined. See
environ(7).
ERRORS
No errors are defined.
USAGE
The
mbstate_t object is used to describe the current conversion state
from a particular character sequence to a wide-character sequence (or
vice versa) under the rules of a particular setting of the
LC_CTYPE category of the current locale.
The initial conversion state corresponds, for a conversion in either
direction, to the beginning of a new character sequence in the
initial shift state. A zero-valued
mbstate_t object is at least one
way to describe an initial conversion state. A zero-valued
mbstate_t object can be used to initiate conversion involving any character
sequence, in any
LC_CTYPE category setting.
ATTRIBUTES
See
attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | See below. |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
The
mbsinit() function is Standard. The
mbsinit_l() function is
Uncommitted.
SEE ALSO
mbrlen(3C),
mbrtowc(3C),
mbsrtowcs(3C),
newlocale(3C),
setlocale(3C),
wcrtomb(3C),
wcsrtombs(3C),
uselocale(),
attributes(7),
environ(7),
standards(7) June 23, 2014 MBSINIT(3C)
