C 语言之snprintf函数

  snprintf 是 C 语言中的一个函数，用于格式化字符串并将结果写入一个字符数组。它属于标准库 <stdio.h>。

1.函数原型

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

①参数说明

• char *str: 指向要写入的字符数组的指针。
• size_t size: 要写入的最大字符数，包括结尾的空字符 \0。这可以防止缓冲区溢出。
• const char *format: 格式控制字符串，类似于 printf 的格式。
• ...: 变长参数列表，用于提供格式字符串中指定的值。

②返回值

• 返回写入 str 的字符数（不包括结尾的空字符），如果返回值大于或等于 size，则表示输出被截断。

2.使用示例

       以下是一个使用 snprintf 的简单示例：

#include <stdio.h>

int main() {
    char buffer[50]; // 创建一个字符数组 buffer，大小为 50 字节
    int num = 42; // 整数变量 num，值为 42
    const char *str = "Hello, World!"; // 字符串 str，内容为 "Hello, World!"

    // 使用 snprintf 格式化字符串
    int written = snprintf(buffer, sizeof(buffer), "Number: %d, Message: %s", num, str);

    // 输出结果
    printf("Formatted string: %s\n", buffer); // 输出格式化后的字符串
    printf("Characters written: %d\n", written); // 输出写入的字符数

    return 0;
}

3.输出结果

①格式化的字符串

       调用 printf("Formatted string: %s\n", buffer); 将输出：

Formatted string: Number: 42, Message: Hello, World!

②写入的字符数

       调用 printf("Characters written: %d\n", written); 将输出：

Characters written: 42

4.注意事项

       ①缓冲区大小: 使用 snprintf 时，务必确保提供的缓冲区足够大，以容纳格式化后的字符串及结尾的空字符。

       ②截断情况: 如果输出被截断，可以通过检查返回值来判断。返回值大于或等于 size 时，表明字符串被截断。

       ③安全性: 相比于 sprintf，snprintf 更加安全，因为它可以防止缓冲区溢出。