mbsinit - Man Page

determine conversion object status


This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.


#include <wchar.h>

int mbsinit(const mbstate_t *ps);


The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2017 defers to the ISO C standard.

If ps is not a null pointer, the mbsinit() function shall determine whether the object pointed to by ps describes an initial conversion state.

Return Value

The mbsinit() function shall return non-zero if ps is a null pointer, or if the pointed-to object describes an initial conversion state; otherwise, it shall return zero.

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.


No errors are defined.

The following sections are informative.



Application 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.



Future Directions


See Also

mbrlen(), mbrtowc(), mbsrtowcs(), wcrtomb(), wcsrtombs()

The Base Definitions volume of POSIX.1-2017, <wchar.h>

Referenced By

freopen(3p), mbrlen(3p), mbrtowc(3p), mbsrtowcs(3p), wchar.h(0p), wcrtomb(3p), wcsrtombs(3p).

2017 IEEE/The Open Group POSIX Programmer's Manual