diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-24 04:52:22 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-24 04:52:22 +0000 |
commit | 7f3caba522f4d24764f29d83aa2de9198bb7f01c (patch) | |
tree | 66b798ea74302325d6a5c11df044cbe4bb845af1 /man3/mbsinit.3 | |
parent | Adding upstream version 6.7. (diff) | |
download | manpages-upstream.tar.xz manpages-upstream.zip |
Adding upstream version 6.8.upstream/6.8upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man3/mbsinit.3')
-rw-r--r-- | man3/mbsinit.3 | 117 |
1 files changed, 0 insertions, 117 deletions
diff --git a/man3/mbsinit.3 b/man3/mbsinit.3 deleted file mode 100644 index fc76d62..0000000 --- a/man3/mbsinit.3 +++ /dev/null @@ -1,117 +0,0 @@ -'\" t -.\" Copyright (c) Bruno Haible <haible@clisp.cons.org> -.\" -.\" SPDX-License-Identifier: GPL-2.0-or-later -.\" -.\" References consulted: -.\" GNU glibc-2 source code and manual -.\" Dinkumware C library reference http://www.dinkumware.com/ -.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html -.\" ISO/IEC 9899:1999 -.\" -.TH mbsinit 3 2024-01-28 "Linux man-pages 6.7" -.SH NAME -mbsinit \- test for initial shift state -.SH LIBRARY -Standard C library -.RI ( libc ", " \-lc ) -.SH SYNOPSIS -.nf -.B #include <wchar.h> -.P -.BI "int mbsinit(const mbstate_t *" ps ); -.fi -.SH DESCRIPTION -Character conversion between the multibyte representation and the wide -character representation uses conversion state, of type -.IR mbstate_t . -Conversion of a string uses a finite-state machine; when it is interrupted -after the complete conversion of a number of characters, it may need to -save a state for processing the remaining characters. -Such a conversion -state is needed for the sake of encodings such as ISO/IEC\~2022 and UTF-7. -.P -The initial state is the state at the beginning of conversion of a string. -There are two kinds of state: the one used by multibyte to wide character -conversion functions, such as -.BR mbsrtowcs (3), -and the one used by wide -character to multibyte conversion functions, such as -.BR wcsrtombs (3), -but they both fit in a -.IR mbstate_t , -and they both have the same -representation for an initial state. -.P -For 8-bit encodings, all states are equivalent to the initial state. -For multibyte encodings like UTF-8, EUC-*, BIG5, or SJIS, the wide character -to multibyte conversion functions never produce non-initial states, but the -multibyte to wide-character conversion functions like -.BR mbrtowc (3) -do -produce non-initial states when interrupted in the middle of a character. -.P -One possible way to create an -.I mbstate_t -in initial state is to set it to zero: -.P -.in +4n -.EX -mbstate_t state; -memset(&state, 0, sizeof(state)); -.EE -.in -.P -On Linux, the following works as well, but might generate compiler warnings: -.P -.in +4n -.EX -mbstate_t state = { 0 }; -.EE -.in -.P -The function -.BR mbsinit () -tests whether -.I *ps -corresponds to an -initial state. -.SH RETURN VALUE -.BR mbsinit () -returns nonzero if -.I *ps -is an initial state, or if -.I ps -is NULL. -Otherwise, it returns 0. -.SH ATTRIBUTES -For an explanation of the terms used in this section, see -.BR attributes (7). -.TS -allbox; -lbx lb lb -l l l. -Interface Attribute Value -T{ -.na -.nh -.BR mbsinit () -T} Thread safety MT-Safe -.TE -.SH STANDARDS -C11, POSIX.1-2008. -.SH HISTORY -POSIX.1-2001, C99. -.SH NOTES -The behavior of -.BR mbsinit () -depends on the -.B LC_CTYPE -category of the -current locale. -.SH SEE ALSO -.BR mbrlen (3), -.BR mbrtowc (3), -.BR mbsrtowcs (3), -.BR wcrtomb (3), -.BR wcsrtombs (3) |