Debian Codegraph @

upstream/debian-trixie/man3/mbsinit.3

raw
1 '\" t
2 .\" Copyright, Bruno Haible <[email protected]>
3 .\" Copyright 2024, Alejandro Colomar <[email protected]>
4 .\"
5 .\" SPDX-License-Identifier: GPL-2.0-or-later
6 .\"
7 .\" References consulted:
8 .\" GNU glibc-2 source code and manual
9 .\" Dinkumware C library reference http://www.dinkumware.com/
10 .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
11 .\" ISO/IEC 9899:1999
12 .\"
13 .TH mbsinit 3 2024-05-03 "Linux man-pages 6.9.1"
14 .SH NAME
15 mbsinit
16 \-
17 test for initial shift state
18 .SH LIBRARY
19 Standard C library
20 .RI ( libc ", " \-lc )
21 .SH SYNOPSIS
22 .nf
23 .B #include <wchar.h>
24 .P
25 .BI "int mbsinit(const mbstate_t *" ps );
26 .fi
27 .SH DESCRIPTION
28 The function
29 .BR mbsinit ()
30 tests whether
31 .I *ps
32 corresponds to an
33 initial state.
34 .SH RETURN VALUE
35 .BR mbsinit ()
36 returns nonzero if
37 .I *ps
38 is an initial state, or if
39 .I ps
40 is NULL.
41 Otherwise, it returns 0.
42 .SH ATTRIBUTES
43 For an explanation of the terms used in this section, see
44 .BR attributes (7).
45 .TS
46 allbox;
47 lbx lb lb
48 l l l.
49 Interface Attribute Value
50 T{
51 .na
52 .nh
53 .BR mbsinit ()
54 T} Thread safety MT-Safe
55 .TE
56 .SH STANDARDS
57 C11, POSIX.1-2008.
58 .SH HISTORY
59 POSIX.1-2001, C99.
60 .SH NOTES
61 The behavior of
62 .BR mbsinit ()
63 depends on the
64 .B LC_CTYPE
65 category of the
66 current locale.
67 .SH SEE ALSO
68 .BR mbstate_t (3type),
69 .BR mbrlen (3),
70 .BR mbrtowc (3),
71 .BR mbsrtowcs (3),
72 .BR wcrtomb (3),
73 .BR wcsrtombs (3)