#some sentences about the functions

This commit is contained in:
Marcus Boerger 2002-06-23 22:12:22 +00:00
parent db39a2efa7
commit 02ac908307

View file

@ -16,6 +16,19 @@
+----------------------------------------------------------------------+ +----------------------------------------------------------------------+
*/ */
/*
The pbuf parameter of all spprintf version receives a pointer to the allocated
buffer. This buffer must be freed manually after usage using efree() function.
The buffer will allways be terminated by a zero character. When pbuf is NULL
the function can be used to calculate the required size of the buffer but for
that purpose snprintf is faster. When both pbuf and the return value are 0
than you are out of memory.
There is also snprintf: See difference explained in snprintf.h
*/
#ifndef SPPRINTF_H #ifndef SPPRINTF_H
#define SPPRINTF_H #define SPPRINTF_H