compiler/clib/snprintf.c

   1 /*
   2     Copyright © 1995-2003, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     ANSI C function snprintf().
   6 */
   7
   8 /*****************************************************************************
   9
  10     NAME */
  11 #include <stdio.h>
  12
  13         int snprintf (
  14
  15 /*  SYNOPSIS */
  16         char       * str,
  17         size_t       n,
  18         const char * format,
  19         ...)
  20
  21 /*  FUNCTION
  22         Formats a list of arguments and writes them into the string str.
  23
  24     INPUTS
  25         str - The formatted string is written into this variable. You
  26                 must make sure that it is large enough to contain the
  27                 result.
  28         n - At most n characters are written into the string. This
  29                 includes the final 0.
  30         format - Format string as described above
  31         ... - Arguments for the format string
  32
  33     RESULT
  34         The number of characters written into the string. The 0 byte at the
  35         end is not included. If this is greater than or equal to n then
  36         there was not enough room to write all characters. In this case the
  37         output string is not null-terminated, and the return value is the
  38         number of characters which would have been written if enough space had
  39         been available.
  40
  41     NOTES
  42
  43     EXAMPLE
  44
  45     BUGS
  46
  47     SEE ALSO
  48         fprintf(), vprintf(), vfprintf(), snprintf(), vsprintf(),
  49         vsnprintf()
  50
  51     INTERNALS
  52
  53 ******************************************************************************/
  54 {
  55     int     retval;
  56     va_list args;
  57
  58     va_start (args, format);
  59
  60     retval = vsnprintf (str, n, format, args);
  61
  62     va_end (args);
  63
  64     return retval;
  65 } /* snprintf */
  66
  67 #ifdef TEST
  68 #include <stdio.h>
  69
  70 int main (int argc, char ** argv)
  71 {
  72     char buffer[11];
  73     int  rc;
  74
  75     printf ("snprintf test\n");
  76
  77     rc = snprintf (buffer, sizeof (buffer), "%10d", 5);
  78
  79     if (rc < sizeof (buffer))
  80         printf ("rc=%d, buffer=\"%s\"\n", rc, buffer);
  81     else
  82         printf ("rc=%d\n", rc);
  83
  84     rc = snprintf (buffer, sizeof (buffer), "%11d", 5);
  85
  86     if (rc < sizeof (buffer))
  87         printf ("rc=%d, buffer=\"%s\"\n", rc, buffer);
  88     else
  89         printf ("rc=%d\n", rc);
  90
  91     return 0;
  92 } /* main */
  93
  94 #endif /* TEST */