luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-27 07:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Expand the g_sprintf docs

Browse Source 
As requested in bug 576833.
This commit is contained in:
Matthias Clasen 2010-07-08 19:23:42 -04:00
parent 7cfa23b177
commit ac342a8d0c
1 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
glib/gprintf.c
View File

@ -90,16 +90,21 @@ g_fprintf (FILE *file,
/** /**
* g_sprintf: * g_sprintf:
* @string: A pointer to a memory buffer to contain the resulting string. It * @string: A pointer to a memory buffer to contain the resulting string. It
* is up to the caller to ensure that the allocated buffer is large * is up to the caller to ensure that the allocated buffer is large
* enough to hold the formatted result * enough to hold the formatted result
* @format: a standard printf() format string, but notice * @format: a standard printf() format string, but notice
* <link linkend="string-precision">string precision pitfalls</link>. * <link linkend="string-precision">string precision pitfalls</link>.
* @Varargs: the arguments to insert in the output. * @Varargs: the arguments to insert in the output.
* *
* An implementation of the standard sprintf() function which supports * An implementation of the standard sprintf() function which supports
* positional parameters, as specified in the Single Unix Specification. * positional parameters, as specified in the Single Unix Specification.
* *
* Note that it is usually better to use g_snprintf(), to avoid the
* risk of buffer overflow.
*
* See also g_strdup_printf().
*
* Returns: the number of bytes printed. * Returns: the number of bytes printed.
* *
* Since: 2.2 * Since: 2.2
@ -122,28 +127,28 @@ g_sprintf (gchar *string,
/** /**
* g_snprintf: * g_snprintf:
* @string: the buffer to hold the output. * @string: the buffer to hold the output.
* @n: the maximum number of bytes to produce (including the * @n: the maximum number of bytes to produce (including the
* terminating nul character). * terminating nul character).
* @format: a standard printf() format string, but notice * @format: a standard printf() format string, but notice
* <link linkend="string-precision">string precision pitfalls</link>. * <link linkend="string-precision">string precision pitfalls</link>.
* @Varargs: the arguments to insert in the output. * @Varargs: the arguments to insert in the output.
* *
* A safer form of the standard sprintf() function. The output is guaranteed * A safer form of the standard sprintf() function. The output is guaranteed
* to not exceed @n characters (including the terminating nul character), so * to not exceed @n characters (including the terminating nul character), so
* it is easy to ensure that a buffer overflow cannot occur. * it is easy to ensure that a buffer overflow cannot occur.
* *
* See also g_strdup_printf(). * See also g_strdup_printf().
* *
* In versions of GLib prior to 1.2.3, this function may return -1 if the * In versions of GLib prior to 1.2.3, this function may return -1 if the
* output was truncated, and the truncated string may not be nul-terminated. * output was truncated, and the truncated string may not be nul-terminated.
* In versions prior to 1.3.12, this function returns the length of the output * In versions prior to 1.3.12, this function returns the length of the output
* string. * string.
* *
* The return value of g_snprintf() conforms to the snprintf() * The return value of g_snprintf() conforms to the snprintf()
* function as standardized in ISO C99. Note that this is different from * function as standardized in ISO C99. Note that this is different from
* traditional snprintf(), which returns the length of the output string. * traditional snprintf(), which returns the length of the output string.
* *
* The format string may contain positional parameters, as specified in * The format string may contain positional parameters, as specified in
* the Single Unix Specification. * the Single Unix Specification.
* *
* Returns: the number of bytes which would be produced if the buffer * Returns: the number of bytes which would be produced if the buffer