C99标准函数snprintf在不同平台的实现差异

snprintf函数原型

C99提供的库函数snprintf的原型为：

int snprintf ( char * str, size_t size, const char * format, ... );

其含义如下：

• str：格式化后输出的目标字符串
• size：常见有两种实现，一是允许写入字符串的长度，不含\0；二是允许写入的字节数，含\0
• format：格式化字符串
• …：可变参数
• 返回值：写入字符串无截断时返回写入str的字符串长度，不含\0；写入字符串有截断时常见有两种实现，一是返回需要写入str的字符串长度，不含\0，二是返回-1。

由于snprintf在不同平台下的实现可能不同，在跨平台使用时需要注意其实现方式。笔者针对VC2015、MinGW-8.5.0及stb库中的实现方式进行了实验，具体如下文所述。

size小于目标字符串长度时

示例代码：

    char buf[12] = { 0 };
    char *str = "Hello world!";
    size_t sz = 3;
    int len = snprintf(buf, sz, "%s", str);
    printf("snprintf: len=%d, and buf=[%s]\n", len, buf);

    len = _snprintf(buf, sz, "%s", str);
    printf("_snprintf: len=%d, and buf=[%s]\n", len, buf);

    len = stbsp_snprintf(buf, sz, "%s", str);
    printf("stbsp_snprintf: len=%d, and buf=[%s]\n", len, buf);

使用VC2015运行上述代码的输出结果为：

snprintf: len=12, and buf=[He]
_snprintf: len=-1, and buf=[Hel]
stbsp_snprintf: len=12, and buf=[He]

使用MinGW-8.5.0运行上述代码的输出结果为：

snprintf: len=-1, and buf=[Hel]
_snprintf: len=-1, and buf=[Hel]
stbsp_snprintf: len=12, and buf=[He]

size等于目标字符串长度时

示例代码：

    char buf[12] = { 0 };
    char *str = "Hello world!";
    size_t sz = 11;
    int len = snprintf(buf, sz, "%s", str);
    printf("snprintf: len=%d, and buf=[%s]\n", len, buf);

    len = _snprintf(buf, sz, "%s", str);
    printf("_snprintf: len=%d, and buf=[%s]\n", len, buf);

    len = stbsp_snprintf(buf, sz, "%s", str);
    printf("stbsp_snprintf: len=%d, and buf=[%s]\n", len, buf);

使用VC2015运行上述代码的输出结果为：

snprintf: len=11, and buf=[Hello worl]
_snprintf: len=11, and buf=[Hello world]
stbsp_snprintf: len=11, and buf=[Hello worl]

size等于目标字符串长度+1时

示例代码：

    char buf[12] = { 0 };
    char *str = "Hello world!";
    size_t sz = 12;
    int len = snprintf(buf, sz, "%s", str);
    printf("snprintf: len=%d, and buf=[%s]\n", len, buf);

    len = _snprintf(buf, sz, "%s", str);
    printf("_snprintf: len=%d, and buf=[%s]\n", len, buf);

    len = stbsp_snprintf(buf, sz, "%s", str);
    printf("stbsp_snprintf: len=%d, and buf=[%s]\n", len, buf);

使用VC2015运行上述代码的输出结果为：

snprintf: len=11, and buf=[Hello world]
_snprintf: len=11, and buf=[Hello world]
stbsp_snprintf: len=11, and buf=[Hello world]

使用MinGW-8.5.0运行上述代码的输出结果为：

snprintf: len=11, and buf=[Hello world]
_snprintf: len=11, and buf=[Hello world]
stbsp_snprintf: len=11, and buf=[Hello world]

实验结果

经过上述实验可知：

实现	size参数	返回值
snprintf(VC2015)	str中允许使用的字节数，包含\0，写入的字符数最大为size-1	无论是否截断，均返回需要写入的字符串长度
snprintf(MinGW8.5.0)	str中允许写入的字符数，不含\0，写入的字符数最大为size	无截断时返回需要写入的字符串长度，截断时返回-1
_snprintf	str中允许写入的字符数，不含\0，写入的字符数最大为size	无截断时返回需要写入的字符串长度，截断时返回-1
stbsp_snprintf	str中允许使用的字节数，包含\0，写入的字符数最大为size-1	无论是否截断，均返回需要写入的字符串长度

不同平台下snprintf的正确使用方式为：

实现	size参数	返回值
snprintf(VC2015)	size最小为目标字符串长度+1，不超过str的内存长度	返回值不小于size表示截断
snprintf(MinGW8.5.0)	size最小为目标字符串长度，不超过str的内存长度-1	返回-1表示截断
_snprintf	size最小为目标字符串长度，不超过str的内存长度-1	返回-1表示截断
stbsp_snprintf	size最小为目标字符串长度+1，不超过str的内存长度	返回值不小于size表示截断

若本实验中的结论与你在网上查阅的资料不一致，建议自己做实验实测一下为好。