knight/shared/KeCommon.h
author Peace-Maker <januk@freenet.de>
Sat May 10 05:42:33 2014 -0700 (2014-05-10)
changeset 4354 7011587e0021
parent 2226 d10b38524be3
permissions -rw-r--r--
Remove LogMessageEx definition from logging.inc (bug 5897, r=kyles).
     1 #ifndef _INCLUDE_KNIGHT_KE_COMMON_UTILS_H_
     2 #define _INCLUDE_KNIGHT_KE_COMMON_UTILS_H_
     3 
     4 #include <stddef.h>
     5 #include <stdarg.h>
     6 
     7 namespace Knight
     8 {
     9 	/**
    10 	 * @brief Formats a buffer with C platform rules.
    11 	 *
    12 	 * Unlink platform snprintf, this will never return nonsense values like -1.
    13 	 *
    14 	 * @param buffer			Buffer to store to.
    15 	 * @param maxlength			Maximum length of buffer (including null terminator).
    16 	 * @param fmt				printf() format string.
    17 	 * @param ...				Formatting arguments.
    18 	 * @return					Number of characters written.
    19 	 */
    20 	extern size_t KE_PFormat(char *buffer, size_t maxlength, const char *fmt, ...);
    21 
    22 	/**
    23 	 * @brief Formats a buffer with C platform rules.
    24 	 *
    25 	 * Unlink platform snprintf, this will never return nonsense values like -1.
    26 	 *
    27 	 * @param buffer			Buffer to store to.
    28 	 * @param maxlength			Maximum length of buffer (including null terminator).
    29 	 * @param fmt				printf() format string.
    30 	 * @param args				Formatting arguments.
    31 	 * @return					Number of characters written.
    32 	 */
    33 	extern size_t KE_PFormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list args);
    34 }
    35 
    36 #endif //_INCLUDE_KNIGHT_KE_COMMON_UTILS_H_