Manual Page Result
0
Command: mbsinit | Section: 3 | Source: Digital UNIX | File: mbsinit.3.gz
mbsinit(3) Library Functions Manual mbsinit(3)
NAME
mbsinit - Determines whether a multibyte-character string is in the
initial conversion state
LIBRARY
Standard C Library (libc.so, libc.a)
SYNOPSIS
#include <wchar.h>
int mbsinit(
const mbstate_t *ps);
STANDARDS
Interfaces documented on this reference page conform to industry stan-
dards as follows:
mbsinit(): ISO C
Refer to the standards(5) reference page for more information about in-
dustry standards and associated tags.
PARAMETERS
Points to an mbstate object that contains the current conversion state
of a string.
DESCRIPTION
The mbsinit() function determines whether the character sequence being
converted is in the initial conversion state; that is, the function de-
termines whether the current character of a character sequence is a
multibyte character in the initial shift state as defined by the
LC_TYPE category of the current locale.
Use this function along with the restartable conversion functions
(mbrlen, mbrtowc, wcrtomb, mbsrtowcs, wcsrtombs) to convert between
multibyte-character and wide-character format. Only restartable con-
version functions use an mbstate_t parameter. Therefore, results are
undefined when restartable and nonrestartable conversion functions op-
erate on the same arrays during a conversion operation.
RESTRICTIONS
The mbsinit() function and restartable versions of conversion routines
are functional only when used with locales that support shift state en-
coding. Currently, the DIGITAL UNIX product does not provide any lo-
cales that use shift state encoding and the mbsinit() function returns
a nonzero value only to indicate that *ps is a null pointer.
RETURN VALUES
The mbsinit() function returns a nonzero value if *ps is a null pointer
or ps describes an initial conversion state; otherwise, the function
returns zero.
RELATED INFORMATION
Functions: mblen(3), mbstowcs(3), mbtowc(3), wcstombs(3), wctomb(3)
Files: locale(4) delim off
mbsinit(3)