[c]可变参数函数

#include <stdio.h>

#include <stdarg.h>

void logMessage(const char *pFormat, ...) {

// 定义一个 va_list 类型的变量 args 用于存储参数信息

va_list args;

// 初始化 args 指向第一个未命名参数

va_start(args, pFormat);

// 创建一个足够大的缓冲区来保存格式化后的字符串

char buffer[1024];

// 使用 vsnprintf 格式化字符串并写入到 buffer 中

int len = vsnprintf(buffer, sizeof(buffer), pFormat, args);

if (len > -1 && len < sizeof(buffer)) {

// 如果 vsnprintf 成功并且没有被截断,则输出结果

printf("%s\n", buffer);

} else {

// 处理错误情况(例如,缓冲区太小)

printf("Buffer too small or formatting error.\n");

}

// 清理工作

va_end(args);

}

int main() {

// 调用 logMessage 函数,它支持类似于 printf 的语法

logMessage("User %s logged in from IP: %s", "Alice", "192.168.1.1");

logMessage("Error code: %d, Message: %s", 404, "Not Found");

return 0;

}

  • **logMessage 函数**: 这是一个接受可变数量参数的函数,首先通过`va_start`初始化`args`,然后调用`vsnprintf`根据提供的格式化字符串和参数生成最终的消息。如果格式化成功且结果没有超出缓冲区大小限制,则使用`printf`输出结果。最后,通过`va_end`完成清理工作。

`vsnprintf` 是 C 标准库中的一个函数,用于格式化字符串并将其输出到一个指定的缓冲区。它与 `snprintf` 类似,但接收的是一个 `va_list` 类型的参数列表而不是直接使用省略号(...)。这使得它非常适合在实现支持可变参数列表的函数时使用。

函数原型

```c

int vsnprintf(char *str, size_t size, const char *format, va_list ap);

```

参数解释

  1. **char *str**

目标缓冲区的指针,格式化后的字符串将被写入该缓冲区。如果 `size` 为零,则可以传递一个空指针,因为在这种情况下不会尝试写入数据,仅返回所需缓冲区大小。

  1. **size_t size**

指定目标缓冲区的最大字节数(包括结尾的空字符 `\0`)。这意味着函数最多会写入 `size - 1` 个字符到 `str` 中,并确保 `str` 以空字符结束。如果格式化后的字符串长度超过了 `size - 1`,则会被截断。

  1. **const char *format**

格式化字符串,包含文本和嵌入的格式说明符(如 `%d` 表示整数,`%s` 表示字符串等)。这些说明符将被后续提供的参数替换。

  1. **va_list ap**

这是一个指向参数列表的指针,包含了所有按照 `format` 中的说明符顺序排列的额外参数。这个参数通常通过 `va_start` 初始化,并且在调用 `vsnprintf` 后应该调用 `va_end` 来清理。

返回值

  • 如果成功并且没有发生截断,则返回写入到 `str` 的字符数(不包括结尾的空字符)。

  • 如果由于缓冲区大小不足而发生截断,则返回将会写入的字符总数(假设没有大小限制),以便你可以知道需要多大的缓冲区来存储完整的格式化字符串。

  • 如果发生错误,返回负值。

使用场景

`vsnprintf` 常用于实现自定义的格式化输出函数,特别是那些需要处理不确定数量参数的情况。例如,构建自己的日志记录函数或调试信息打印函数时非常有用。

示例代码片段

以下是一个简单的例子,演示了如何使用 `vsnprintf`:

```c

#include <stdio.h>

#include <stdarg.h>

void logMessage(const char *format, ...) {

char buffer[1024];

va_list args;

va_start(args, format);

int len = vsnprintf(buffer, sizeof(buffer), format, args);

va_end(args);

if (len > -1 && len < sizeof(buffer)) {

printf("%s\n", buffer);

} else {

printf("Error: Buffer too small or formatting error.\n");

}

}

int main() {

logMessage("User %s logged in from IP: %s", "Alice", "192.168.1.1");

logMessage("Error code: %d, Message: %s", 404, "Not Found");

return 0;

}

```

相关推荐
小麦嵌入式19 分钟前
Linux驱动开发实战(十一):GPIO子系统深度解析与RGB LED驱动实践
linux·c语言·驱动开发·stm32·嵌入式硬件·物联网·ubuntu
云 无 心 以 出 岫1 小时前
贪心算法QwQ
数据结构·c++·算法·贪心算法
jelasin1 小时前
LibCoroutine开发手记:细粒度C语言协程库
c语言
换一颗红豆1 小时前
【C++ 多态】—— 礼器九鼎,釉下乾坤,多态中的 “风水寻龙诀“
c++
篝火悟者1 小时前
自学-C语言-基础-数组、函数、指针、结构体和共同体、文件
c语言·开发语言
随便昵称2 小时前
蓝桥杯专项复习——前缀和和差分
c++·算法·前缀和·蓝桥杯
commonbelive2 小时前
团体程序设计天梯赛——L1-100 四项全能
c++
genispan2 小时前
QT/C++ 多线程并发下载实践
开发语言·c++·qt
小卡皮巴拉3 小时前
【力扣刷题实战】矩阵区域和
开发语言·c++·算法·leetcode·前缀和·矩阵
Pacify_The_North3 小时前
【C++进阶三】vector深度剖析(迭代器失效和深浅拷贝)
开发语言·c++·windows·visualstudio