C 库函数 - snprintf()

C 标准库 - <stdio.h> C 标准库 - <stdio.h>

描述

C 库函数 int snprintf(char *str, size_t size, const char *format, ...) 设将可变参数(...)按照 format 格式化成字符串，并将字符串复制到 str 中，size 为要写入的字符的最大数目，超过 size 会被截断，最多写入 size-1 个字符。

与 sprintf() 函数不同的是，snprintf() 函数提供了一个参数 size，可以防止缓冲区溢出。如果格式化后的字符串长度超过了 size-1，则 snprintf() 只会写入 size-1 个字符，并在字符串的末尾添加一个空字符（）以表示字符串的结束。

声明

下面是 snprintf() 函数的声明。

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

参数

  • str -- 目标字符串，用于存储格式化后的字符串的字符数组的指针。
  • size -- 字符数组的大小。
  • format -- 格式化字符串。
  • ... -- 可变参数，可变数量的参数根据 format 中的格式化指令进行格式化。

返回值

snprintf() 函数返回写入字符数组的字符数，不包括字符串的结束符。如果格式化后的字符串的长度大于等于 size，则返回应该被写入字符数组的字符数，但不包括字符串的结束符。

  • 1、如果格式化后的字符串长度小于 size，则会把字符串全部复制到 str 中，并给其后添加一个字符串结束符 ；

  • 2、如果格式化后的字符串长度大于等于 size，超过 size 的部分会被截断，只将其中的 (size-1) 个字符复制到 str 中，并给其后添加一个字符串结束符 ，返回值为欲写入的字符串长度。

实例

下面的实例演示了 snprintf() 函数的用法。

实例

#include <stdio.h>
 
int main()
{
    char buffer[50];
    char* s = "muban99com";
 
    // 读取字符串并存储在 buffer 中
    int j = snprintf(buffer, 6, "%s ", s);
 
    // 输出 buffer及字符数
    printf("string: %s character count = %d ", buffer, j);
 
    return 0;
}

输出结果为：

string:
runoo
character count = 10

注意事项：

  • snprintf() 函数在格式化字符串时，可以避免缓冲区溢出。
  • 如果格式化后的字符串的长度超过了 size-1，则 snprintf() 函数只会写入 size-1 个字符，并在字符串的末尾添加一个空字符（）以表示字符串的结束。
  • 如果 str 参数为 NULL，则 snprintf() 函数不会写入任何字符，但仍然返回计划写入的字符数。
  • 如果 size 参数为 0，则 snprintf() 函数不会写入任何字符，但仍然返回计划写入的字符数。
  • snprintf() 函数不支持浮点数的格式化，如果需要格式化浮点数，应使用 sprintf() 函数。
  • 在使用 snprintf() 函数时，需要注意格式化字符串的安全性，尤其是在使用用户提供的字符串时。如果格式化字符串中包含用户输入的字符串，并且该字符串中包含格式化指令，可能会导致安全问题。可以使用一些安全的字符串格式化库，例如 snprintf_s()，_snprintf()，_sntprintf() 等。

C 标准库 - <stdio.h> C 标准库 - <stdio.h>