snprintf.c: Doc fix.

* snprintf.c: Doc fix.

* vsnprintf.c: Doc fix.

From-SVN: r147998
This commit is contained in:
Eli Zaretskii 2009-05-30 05:17:14 +00:00 committed by DJ Delorie
parent acd262252c
commit ec5c6f4a5f
3 changed files with 24 additions and 14 deletions

View File

@ -1,3 +1,9 @@
2009-05-30 Eli Zaretskii <eliz@gnu.org>
* snprintf.c: Doc fix.
* vsnprintf.c: Doc fix.
2009-05-29 Kai Tietz <kai.tietz@onevision.com>
* pex-win32.c (pex_win32_fdopenr): Set INHERIT to false.

View File

@ -27,13 +27,15 @@ the executable file might be covered by the GNU General Public License. */
@deftypefn Supplemental int snprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, ...)
This function is similar to sprintf, but it will print at most @var{n}
characters. On error the return value is -1, otherwise it returns the
number of characters that would have been printed had @var{n} been
sufficiently large, regardless of the actual value of @var{n}. Note
some pre-C99 system libraries do not implement this correctly so users
cannot generally rely on the return value if the system version of
this function is used.
This function is similar to @code{sprintf}, but it will write to
@var{buf} at most @code{@var{n}-1} bytes of text, followed by a
terminating null byte, for a total of @var{n} bytes.
On error the return value is -1, otherwise it returns the number of
bytes, not including the terminating null byte, that would have been
written had @var{n} been sufficiently large, regardless of the actual
value of @var{n}. Note some pre-C99 system libraries do not implement
this correctly so users cannot generally rely on the return value if
the system version of this function is used.
@end deftypefn

View File

@ -27,13 +27,15 @@ the executable file might be covered by the GNU General Public License. */
@deftypefn Supplemental int vsnprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, va_list @var{ap})
This function is similar to vsprintf, but it will print at most
@var{n} characters. On error the return value is -1, otherwise it
returns the number of characters that would have been printed had
@var{n} been sufficiently large, regardless of the actual value of
@var{n}. Note some pre-C99 system libraries do not implement this
correctly so users cannot generally rely on the return value if the
system version of this function is used.
This function is similar to @code{vsprintf}, but it will write to
@var{buf} at most @code{@var{n}-1} bytes of text, followed by a
terminating null byte, for a total of @var{n} bytes. On error the
return value is -1, otherwise it returns the number of characters that
would have been printed had @var{n} been sufficiently large,
regardless of the actual value of @var{n}. Note some pre-C99 system
libraries do not implement this correctly so users cannot generally
rely on the return value if the system version of this function is
used.
@end deftypefn