Autodoc corrections
[cake.git] / compiler / clib / sprintf.c
blob86f5cc5e544fd8a0c62fe5faa1ed4875fb9aa672
1 /*
2 Copyright © 1995-2003, The AROS Development Team. All rights reserved.
3 $Id$
5 ANSI C function sprintf().
6 */
8 #define _LIBC_KERNEL_
9 #define sprintf sprintf
11 /*****************************************************************************
13 NAME */
14 #include <stdio.h>
16 int sprintf (
18 /* SYNOPSIS */
19 char * str,
20 const char * format,
21 ...)
23 /* FUNCTION
24 Formats a list of arguments and writes them into the string str.
26 INPUTS
27 str - The formatted string is written into this variable. You
28 must make sure that it is large enough to contain the
29 result.
30 format - Format string as described above
31 ... - Arguments for the format string
33 RESULT
34 The number of characters written into the string.
36 NOTES
37 No checks are made that str is large enough for the result.
39 EXAMPLE
41 BUGS
43 SEE ALSO
44 fprintf(), vprintf(), vfprintf(), snprintf(), vsprintf(),
45 vsnprintf()
47 INTERNALS
49 *****************************************************************************/
51 int retval;
52 va_list args;
54 va_start (args, format);
56 retval = vsprintf (str, format, args);
58 va_end (args);
60 return retval;
61 } /* sprintf */