xref: /freebsd/lib/libc/locale/isdigit.3 (revision 6780ab54325a71e7e70112b11657973edde8655e)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)isdigit.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD$
38.\"
39.Dd October 6, 2002
40.Dt ISDIGIT 3
41.Os
42.Sh NAME
43.Nm isdigit, isnumber
44.Nd decimal-digit character test
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.In ctype.h
49.Ft int
50.Fn isdigit "int c"
51.Ft int
52.Fn isnumber "int c"
53.Sh DESCRIPTION
54The
55.Fn isdigit
56function tests for any decimal-digit character.
57For any locale,
58this includes the following characters only:
59.Pp
60.Bl -column \&``0''______ \&``0''______ \&``0''______ \&``0''______ \&``0''______
61.It "\&``0''\t``1''\t``2''\t``3''\t``4''"
62.It "\&``5''\t``6''\t``7''\t``8''\t``9''"
63.El
64.Pp
65For single C
66.Va char Ns s
67locales (see
68.Xr multibyte 3 )
69the value of the argument is
70representable as an
71.Li unsigned char
72or the value of
73.Dv EOF .
74.Sh RETURN VALUES
75The
76.Fn isdigit
77function returns zero if the character tests false and
78returns non-zero if the character tests true.
79.Sh COMPATIBILITY
80Although
81.Fn isdigit
82accepts arguments outside of the range of the
83.Vt "unsigned char"
84type in locales with large character sets,
85this is a
86.Bx 4.4
87extension and the
88.Fn iswdigit
89function should be used instead for maximum portability.
90.Sh SEE ALSO
91.Xr ctype 3 ,
92.Xr iswdigit 3 ,
93.Xr multibyte 3 ,
94.Xr ascii 7
95.Sh STANDARDS
96The
97.Fn isdigit
98function conforms to
99.St -isoC .
100