lib/libc/stdio/scanf.3

   1 .\"     $NetBSD: scanf.3,v 1.27 2010/05/14 03:04:32 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" Chris Torek and the American National Standards Committee X3,
   8 .\" on Information Processing Systems.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)scanf.3     8.2 (Berkeley) 12/11/93
  35 .\"
  36 .Dd March 21, 2010
  37 .Dt SCANF 3
  38 .Os
  39 .Sh NAME
  40 .Nm scanf ,
  41 .Nm fscanf ,
  42 .Nm sscanf ,
  43 .Nm vscanf ,
  44 .Nm vsscanf ,
  45 .Nm vfscanf
  46 .Nd input format conversion
  47 .Sh LIBRARY
  48 .Lb libc
  49 .Sh SYNOPSIS
  50 .In stdio.h
  51 .Ft int
  52 .Fn scanf "const char * restrict format" ...
  53 .Ft int
  54 .Fn fscanf "FILE * restrict stream" "const char * restrict format" ...
  55 .Ft int
  56 .Fn sscanf "const char * restrict str" "const char * restrict format" ...
  57 .In stdarg.h
  58 .Ft int
  59 .Fn vscanf "const char * restrict format" "va_list ap"
  60 .Ft int
  61 .Fn vsscanf "const char * restrict str" "const char * restrict format" "va_list ap"
  62 .Ft int
  63 .Fn vfscanf "FILE * restrict stream" "const char * restrict format" "va_list ap"
  64 .Sh DESCRIPTION
  65 The
  66 .Fn scanf
  67 family of functions scans input according to a
  68 .Fa format
  69 as described below.
  70 This format may contain
  71 .Em conversion specifiers ;
  72 the results from such conversions, if any,
  73 are stored through the
  74 .Em pointer
  75 arguments.
  76 .Pp
  77 The
  78 .Fn scanf
  79 function
  80 reads input from the standard input stream
  81 .Em stdin ,
  82 .Fn fscanf
  83 reads input from the stream pointer
  84 .Fa stream ,
  85 and
  86 .Fn sscanf
  87 reads its input from the character string pointed to by
  88 .Fa str .
  89 The
  90 .Fn vfscanf
  91 function
  92 is analogous to
  93 .Xr vfprintf 3
  94 and reads input from the stream pointer
  95 .Fa stream
  96 using a variable argument list of pointers (see
  97 .Xr stdarg 3 ) .
  98 The
  99 .Fn vscanf
 100 function scans a variable argument list from the standard input and
 101 the
 102 .Fn vsscanf
 103 function scans it from a string;
 104 these are analogous to
 105 the
 106 .Fn vprintf
 107 and
 108 .Fn vsprintf
 109 functions respectively.
 110 .Pp
 111 Each successive
 112 .Em pointer
 113 argument must correspond properly with
 114 each successive conversion specifier
 115 (but see `suppression' below).
 116 All conversions are introduced by the
 117 .Cm %
 118 (percent sign) character.
 119 The
 120 .Fa format
 121 string
 122 may also contain other characters.
 123 White space (such as blanks, tabs, or newlines) in the
 124 .Fa format
 125 string match any amount of white space, including none, in the input.
 126 Everything else
 127 matches only itself.
 128 Scanning stops
 129 when an input character does not match such a format character.
 130 Scanning also stops
 131 when an input conversion cannot be made (see below).
 132 .Sh CONVERSIONS
 133 Following the
 134 .Cm %
 135 character introducing a conversion
 136 there may be a number of
 137 .Em flag
 138 characters, as follows:
 139 .Bl -tag -width indent
 140 .It Cm *
 141 Suppresses assignment.
 142 The conversion that follows occurs as usual, but no pointer is used;
 143 the result of the conversion is simply discarded.
 144 .It Cm h
 145 Indicates that the conversion will be one of
 146 .Cm dioux
 147 or
 148 .Cm n
 149 and the next pointer is a pointer to a
 150 .Em short int
 151 (rather than
 152 .Em int ) .
 153 .It Cm hh
 154 Indicates that the conversion will be one of
 155 .Cm dioux
 156 or
 157 .Cm n
 158 and the next pointer is a pointer to a
 159 .Em char
 160 (rather than
 161 .Em int ) .
 162 .It Cm j
 163 Indicates that the conversion will be one of
 164 .Cm dioux
 165 or
 166 .Cm n
 167 and the next pointer is a pointer to an
 168 .Em intmax_t
 169 (rather than
 170 .Em int ) .
 171 .It Cm l
 172 Indicates either that the conversion will be one of
 173 .Cm dioux
 174 or
 175 .Cm n
 176 and the next pointer is a pointer to a
 177 .Em long int
 178 (rather than
 179 .Em int ) ,
 180 or that the conversion will be one of
 181 .Cm efg
 182 and the next pointer is a pointer to
 183 .Em double
 184 (rather than
 185 .Em float ) .
 186 .It Cm ll
 187 Indicates that the conversion will be one of
 188 .Cm dioux
 189 or
 190 .Cm n
 191 and the next pointer is a pointer to a
 192 .Em long long int
 193 (rather than
 194 .Em int ) .
 195 .It Cm q
 196 Indicates that the conversion will be one of
 197 .Cm dioux
 198 or
 199 .Cm n
 200 and the next pointer is a pointer to a
 201 .Em quad_t
 202 (rather than
 203 .Em int ) .
 204 .It Cm t
 205 Indicates that the conversion will be one of
 206 .Cm dioux
 207 or
 208 .Cm n
 209 and the next pointer is a pointer to a
 210 .Em ptrdiff_t
 211 (rather than
 212 .Em int ) .
 213 .It Cm z
 214 Indicates that the conversion will be one of
 215 .Cm dioux
 216 or
 217 .Cm n
 218 and the next pointer is a pointer to a
 219 .Em size_t
 220 (rather than
 221 .Em int ) .
 222 .It Cm L
 223 Indicates that the conversion will be
 224 .Cm efg
 225 and the next pointer is a pointer to
 226 .Em long double .
 227 .El
 228 .Pp
 229 In addition to these flags,
 230 there may be an optional maximum field width,
 231 expressed as a decimal integer,
 232 between the
 233 .Cm %
 234 and the conversion.
 235 If no width is given,
 236 a default of `infinity' is used (with one exception, below);
 237 otherwise at most this many characters are scanned
 238 in processing the conversion.
 239 Before conversion begins,
 240 most conversions skip white space;
 241 this white space is not counted against the field width.
 242 .Pp
 243 The following conversions are available:
 244 .Bl -tag -width XXXX
 245 .It Cm %
 246 Matches a literal `%'.
 247 That is, `%\&%' in the format string
 248 matches a single input `%' character.
 249 No conversion is done, and assignment does not occur.
 250 .It Cm d
 251 Matches an optionally signed decimal integer;
 252 the next pointer must be a pointer to
 253 .Em int .
 254 .It Cm D
 255 Equivalent to
 256 .Cm ld ;
 257 this exists only for backwards compatibility.
 258 .It Cm i
 259 Matches an optionally signed integer;
 260 the next pointer must be a pointer to
 261 .Em int .
 262 The integer is read in base 16 if it begins
 263 with
 264 .Ql 0x
 265 or
 266 .Ql 0X ,
 267 in base 8 if it begins with
 268 .Ql 0 ,
 269 and in base 10 otherwise.
 270 Only characters that correspond to the base are used.
 271 .It Cm o
 272 Matches an octal integer;
 273 the next pointer must be a pointer to
 274 .Em unsigned int .
 275 .It Cm O
 276 Equivalent to
 277 .Cm lo ;
 278 this exists for backwards compatibility.
 279 .It Cm u
 280 Matches an optionally signed decimal integer;
 281 the next pointer must be a pointer to
 282 .Em unsigned int .
 283 .It Cm x
 284 Matches an optionally signed hexadecimal integer;
 285 the next pointer must be a pointer to
 286 .Em unsigned int .
 287 .It Cm X
 288 Equivalent to
 289 .Cm x .
 290 .It Cm f
 291 Matches an optionally signed floating-point number;
 292 the next pointer must be a pointer to
 293 .Em float .
 294 .It Cm e
 295 Equivalent to
 296 .Cm f .
 297 .It Cm g
 298 Equivalent to
 299 .Cm f .
 300 .It Cm E
 301 Equivalent to
 302 .Cm f .
 303 .It Cm G
 304 Equivalent to
 305 .Cm f .
 306 .It Cm s
 307 Matches a sequence of non-white-space characters;
 308 the next pointer must be a pointer to
 309 .Em char ,
 310 and the array must be large enough to accept all the sequence and the
 311 terminating
 312 .Dv NUL
 313 character.
 314 The input string stops at white space
 315 or at the maximum field width, whichever occurs first.
 316 .It Cm c
 317 Matches a sequence of
 318 .Em width
 319 count
 320 characters (default 1);
 321 the next pointer must be a pointer to
 322 .Em char ,
 323 and there must be enough room for all the characters
 324 (no terminating
 325 .Dv NUL
 326 is added).
 327 The usual skip of leading white space is suppressed.
 328 To skip white space first, use an explicit space in the format.
 329 .It Cm \&[
 330 Matches a nonempty sequence of characters from the specified set
 331 of accepted characters;
 332 the next pointer must be a pointer to
 333 .Em char ,
 334 and there must be enough room for all the characters in the string,
 335 plus a terminating
 336 .Dv NUL
 337 character.
 338 The usual skip of leading white space is suppressed.
 339 The string is to be made up of characters in
 340 (or not in)
 341 a particular set;
 342 the set is defined by the characters between the open bracket
 343 .Cm \&[
 344 character
 345 and a close bracket
 346 .Cm \&]
 347 character.
 348 The set
 349 .Em excludes
 350 those characters
 351 if the first character after the open bracket is a circumflex
 352 .Cm ^ .
 353 To include a close bracket in the set,
 354 make it the first character after the open bracket
 355 or the circumflex;
 356 any other position will end the set.
 357 The hyphen character
 358 .Cm -
 359 is also special;
 360 when placed between two other characters,
 361 it adds all intervening characters to the set.
 362 To include a hyphen,
 363 make it the last character before the final close bracket.
 364 For instance,
 365 .Ql [^]0-9-]
 366 means the set `everything except close bracket, zero through nine,
 367 and hyphen'.
 368 The string ends with the appearance of a character not in the
 369 (or, with a circumflex, in) set
 370 or when the field width runs out.
 371 .It Cm p
 372 Matches a pointer value (as printed by
 373 .Ql %p
 374 in
 375 .Xr printf 3 ) ;
 376 the next pointer must be a pointer to
 377 .Em void .
 378 .It Cm n
 379 Nothing is expected;
 380 instead, the number of characters consumed thus far from the input
 381 is stored through the next pointer,
 382 which must be a pointer to
 383 .Em int .
 384 This is
 385 .Em not
 386 a conversion, although it can be suppressed with the
 387 .Cm *
 388 flag.
 389 .El
 390 .Pp
 391 For backwards compatibility,
 392 other conversion characters (except
 393 .Ql \e0 )
 394 are taken as if they were
 395 .Ql %d
 396 or, if uppercase,
 397 .Ql %ld ,
 398 and a `conversion' of
 399 .Ql %\e0
 400 causes an immediate return of
 401 .Dv EOF .
 402 .Pp
 403 The format string specifier macros described in
 404 .Xr inttypes 3
 405 should be used for the standard
 406 .Dq C99
 407 fixed-size integers documented in
 408 .Xr stdint 3 .
 409 .Sh RETURN VALUES
 410 These
 411 functions
 412 return
 413 the number of input items assigned, which can be fewer than provided
 414 for, or even zero, in the event of a matching failure.
 415 Zero
 416 indicates that, while there was input available,
 417 no conversions were assigned;
 418 typically this is due to an invalid input character,
 419 such as an alphabetic character for a
 420 .Ql %d
 421 conversion.
 422 The value
 423 .Dv EOF
 424 is returned if an input failure occurs before any conversion such as an
 425 end-of-file occurs.
 426 If an error or end-of-file occurs after conversion has begun,
 427 the number of conversions which were successfully completed is returned.
 428 .Sh SEE ALSO
 429 .Xr getc 3 ,
 430 .Xr inttypes 3 ,
 431 .Xr printf 3 ,
 432 .Xr strtod 3 ,
 433 .Xr strtol 3 ,
 434 .Xr strtoul 3
 435 .Sh STANDARDS
 436 The functions
 437 .Fn fscanf ,
 438 .Fn scanf ,
 439 and
 440 .Fn sscanf
 441 conform to
 442 .St -isoC-90 .
 443 The
 444 .Cm %j ,
 445 .Cm %t
 446 and
 447 .Cm %z
 448 conversion format modifiers
 449 conform to
 450 .St -isoC-99 .
 451 The
 452 .Fn vfscanf ,
 453 .Fn vscanf
 454 and
 455 .Fn vsscanf
 456 functions conform to
 457 .St -isoC-99 .
 458 .Sh HISTORY
 459 The functions
 460 .Fn vscanf ,
 461 .Fn vsscanf
 462 and
 463 .Fn vfscanf
 464 appeared in
 465 .Bx 4.4
 466 or even
 467 .Bx 4.3 .
 468 .Sh NOTES
 469 All of the backwards compatibility formats will be removed in the future.
 470 .Sh BUGS
 471 Numerical strings are truncated to 512 characters; for example,
 472 .Cm %f
 473 and
 474 .Cm %d
 475 are implicitly
 476 .Cm %512f
 477 and
 478 .Cm %512d .