libiberty/snprintf.c

   1 /* Implement the snprintf function.
   2    Copyright (C) 2003-2024 Free Software Foundation, Inc.
   3    Written by Kaveh R. Ghazi <ghazi@caip.rutgers.edu>.
   4
   5 This file is part of the libiberty library.  This library is free
   6 software; you can redistribute it and/or modify it under the
   7 terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 This library is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU CC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
  19
  20 As a special exception, if you link this library with files
  21 compiled with a GNU compiler to produce an executable, this does not cause
  22 the resulting executable to be covered by the GNU General Public License.
  23 This exception does not however invalidate any other reasons why
  24 the executable file might be covered by the GNU General Public License. */
  25
  26 /*
  27
  28 @deftypefn Supplemental int snprintf (char *@var{buf}, size_t @var{n}, @
  29   const char *@var{format}, ...)
  30
  31 This function is similar to @code{sprintf}, but it will write to
  32 @var{buf} at most @code{@var{n}-1} bytes of text, followed by a
  33 terminating null byte, for a total of @var{n} bytes.
  34 On error the return value is -1, otherwise it returns the number of
  35 bytes, not including the terminating null byte, that would have been
  36 written had @var{n} been sufficiently large, regardless of the actual
  37 value of @var{n}.  Note some pre-C99 system libraries do not implement
  38 this correctly so users cannot generally rely on the return value if
  39 the system version of this function is used.
  40
  41 @end deftypefn
  42
  43 */
  44
  45 #include "ansidecl.h"
  46
  47 #include <stdarg.h>
  48 #include <stddef.h>
  49
  50 int vsnprintf (char *, size_t, const char *, va_list);
  51
  52 int
  53 snprintf (char *s, size_t n, const char *format, ...)
  54 {
  55   int result;
  56   va_list ap;
  57   va_start (ap, format);
  58   result = vsnprintf (s, n, format, ap);
  59   va_end (ap);
  60   return result;
  61 }