| mbrtowc.3 (279062fae149e105dae7c28b638d49ba5715725d) | mbrtowc.3 (8b8109275c1a583e96171df08e3136151c02279e) |
|---|---|
| 1.\" Copyright (c) 2002 Tim J. Robbins | 1.\" Copyright (c) 2002-2004 Tim J. Robbins |
| 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright --- 9 unchanged lines hidden (view full) --- 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" | 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright --- 9 unchanged lines hidden (view full) --- 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" |
| 27.Dd August 15, 2002 | 27.Dd April 8, 2004 |
| 28.Dt MBRTOWC 3 29.Os 30.Sh NAME 31.Nm mbrtowc 32.Nd "convert a character to a wide-character code (restartable)" 33.Sh LIBRARY 34.Lb libc 35.Sh SYNOPSIS --- 5 unchanged lines hidden (view full) --- 41.Fc 42.Sh DESCRIPTION 43The 44.Fn mbrtowc 45function inspects at most 46.Fa n 47bytes pointed to by 48.Fa s | 28.Dt MBRTOWC 3 29.Os 30.Sh NAME 31.Nm mbrtowc 32.Nd "convert a character to a wide-character code (restartable)" 33.Sh LIBRARY 34.Lb libc 35.Sh SYNOPSIS --- 5 unchanged lines hidden (view full) --- 41.Fc 42.Sh DESCRIPTION 43The 44.Fn mbrtowc 45function inspects at most 46.Fa n 47bytes pointed to by 48.Fa s |
| 49and interprets them as a multibyte character sequence 50according to the current setting of 51.Ev LC_CTYPE . 52If | 49to determine the number of bytes needed to complete the next multibyte 50character. 51If a character can be completed, and |
| 53.Fa pwc 54is not 55.Dv NULL , | 52.Fa pwc 53is not 54.Dv NULL , |
| 56the multibyte character which | 55the wide character which is represented by |
| 57.Fa s | 56.Fa s |
| 58represents is stored in the | 57is stored in the |
| 59.Vt wchar_t 60it points to. 61.Pp 62If 63.Fa s 64is 65.Dv NULL , 66.Fn mbrtowc --- 13 unchanged lines hidden (view full) --- 80argument, 81.Fa ps , 82is used to keep track of the shift state. 83If it is 84.Dv NULL , 85.Fn mbrtowc 86uses an internal, static 87.Vt mbstate_t | 58.Vt wchar_t 59it points to. 60.Pp 61If 62.Fa s 63is 64.Dv NULL , 65.Fn mbrtowc --- 13 unchanged lines hidden (view full) --- 79argument, 80.Fa ps , 81is used to keep track of the shift state. 82If it is 83.Dv NULL , 84.Fn mbrtowc 85uses an internal, static 86.Vt mbstate_t |
| 88object. | 87object, which is initialized to the initial conversion state 88at program startup. |
| 89.Sh RETURN VALUES 90The 91.Fn mbrtowc 92functions returns: 93.Bl -tag -width indent 94.It 0 | 89.Sh RETURN VALUES 90The 91.Fn mbrtowc 92functions returns: 93.Bl -tag -width indent 94.It 0 |
| 95The first | 95The next |
| 96.Fa n | 96.Fa n |
| 97or fewer bytes of 98.Fa s | 97or fewer bytes |
| 99represent the null wide character 100.Pq Li "L'\e0'" . 101.It >0 | 98represent the null wide character 99.Pq Li "L'\e0'" . 100.It >0 |
| 102The first | 101The next |
| 103.Fa n | 102.Fa n |
| 104or fewer bytes of 105.Fa s | 103or fewer bytes |
| 106represent a valid character, 107.Fn mbrtowc | 104represent a valid character, 105.Fn mbrtowc |
| 108returns the length (in bytes) of the multibyte sequence. | 106returns the number of bytes used to complete the multibyte character. |
| 109.It Po Vt size_t Pc Ns \-2 | 107.It Po Vt size_t Pc Ns \-2 |
| 110The first | 108The next |
| 111.Fa n | 109.Fa n |
| 112bytes of 113.Fa s 114are an incomplete multibyte sequence. | 110contribute to, but do not complete, a valid multibyte character sequence, 111and all 112.Fa n 113bytes have been processed. |
| 115.It Po Vt size_t Pc Ns \-1 | 114.It Po Vt size_t Pc Ns \-1 |
| 116The byte sequence pointed to by 117.Fa s 118is an invalid multibyte sequence. | 115An encoding error has occurred. 116The next 117.Fa fn 118or fewer bytes do not contribute to a valid multibyte character. |
| 119.El 120.Sh ERRORS 121The 122.Fn mbrtowc 123function will fail if: 124.Bl -tag -width Er | 119.El 120.Sh ERRORS 121The 122.Fn mbrtowc 123function will fail if: 124.Bl -tag -width Er |
| 125.\".It Bq Er EINVAL 126.\"Invalid argument. | |
| 127.It Bq Er EILSEQ 128An invalid multibyte sequence was detected. | 125.It Bq Er EILSEQ 126An invalid multibyte sequence was detected. |
| 127.It Bq Er EINVAL 128The conversion state is invalid. |
|
| 129.El 130.Sh SEE ALSO 131.Xr mbtowc 3 , | 129.El 130.Sh SEE ALSO 131.Xr mbtowc 3 , |
| 132.Xr multibyte 3 , |
|
| 132.Xr setlocale 3 , 133.Xr wcrtomb 3 134.Sh STANDARDS 135The 136.Fn mbrtowc 137function conforms to 138.St -isoC-99 . | 133.Xr setlocale 3 , 134.Xr wcrtomb 3 135.Sh STANDARDS 136The 137.Fn mbrtowc 138function conforms to 139.St -isoC-99 . |
| 139.Sh BUGS 140The current implementation does not support shift states. | |