C++学习笔记——不定参数函数方法VA_LIST

在之前对于轻量级日志类的学习中我发现作者在日志类里使用了一个参数为未定数量和类型的函数，其声明如下：

//写严重错误信息
		void TraceFatal(const char *lpcszFormat, ...);

在这个函数中实际传递进去的参数有3个，但是声明时却未规定其参数的数量和类型，这就是今天所接触到的不定参数方法的实现。

VA_LIST宏：

要实现不定参数的函数方法主要依靠C++中的VA_LIST宏定义。
VA_LIST使用需要包含头文件<stdarg.h>。
在函数中使用VA_LIST，首先需要定义一个va_list型变量来作为输入的不定参数流的句柄，类似socket中的socket型变量，用来看作当前输入的不定参数流的标记。
在VA_LIST中，主要有以下几个可调用接口：

va_start(va_list arg,char *format)：用以开启不定参数队列的接收，arg为定义的不定参数队列的句柄，format为函数定义中的第一项确定类型的参数。本质为执行arg = (va_list)&arg + SIZEOF(format)，即将句柄变为指向第一个不定参数的地址。

va_arg(va_list arg, type）：用以读取arg句柄所指向地址的下一个不定参数，type为读取时设定的变量类型，**如果参数为char而设定type为int，则会强制转换为ASCII码值，变为int型数据。反之亦然。**这个函数的返回值就是读取的下一个参数值。

va_end(va_list arg) ：用以结束读取不定参数队列，arg为参数队列句柄。

VA_LIST用法实例：

通过上述宏定义可以看出VA_LIST可以将第一个确定参数设作不定参数的数量或者一个普通的数据，实例：

#include <cstdarg>
#include <iostream>

//定义一个函数实现累加计算功能，第一个参数可设置为输入计算的参数的数量
int add(int num ,...)
{
	va_list arg;
	va_start( arg, num); //开启va_list，num为一共有几个数要累加
	int i;
	int sum = 0; //定义累加的值放入sum
	for(i = 0;i < num;i++)
	{
		sum += va_arg( arg, int); //依次读取下一个参数并累加
	}
	return sum；
}

int main()
{
	int sum;
	sum = add( 3, 1, 2, 3);
	std::cout << sum << endl;
	return 0;
}

上述代码输出为：1+2+3 = 6；

格式化输入VA_LIST：

除了上述的简单函数，VA_LIST还有一个更有用的功能，可以对VA_LIST进行格式化的输入。具体过程是将函数定义为如下格式：

vaprint（char *format,...)

函数中第一个参数不再代表一个普通的数据，而是代表一个格式化输出语句的输出格式，对于传递进函数的format变量，其格式与printf中的格式化输出格式类似，即：“Message : %d, %c, …”。
设置format输出格式后可用vanprintf或vanprintf_s来将VA_LIST中的各个参数按照format规定的输出格式来进行打印或写入字符串。
实例：

#include <cstdarg>
#include <iostream>

int test(char *format, ...)
{
	va_list arg;
	char buff[30];
	va_start(arg, format);
	//用vsnprintf_s函数将不定参数按format格式写入buff中
	int count = vsnprintf_s(buff, sizeof(buff), sizeof(buff) - sizeof(char), format, arg);
	//vsnprintf_s函数的返回值为总共读取的不定参数的数量
	//vsnprintf_s函数的参数定义有两种形式，还有一种只有三个参数，本质区别不大
	if (count <= 0)
	{
		printf("va buff read fail\n");
		va_end(arg);
		return -1;
	}
	printf("%s", buff);
	va_end(arg);
	return 0;
}
int main()
{
	test("Msg:%d - %c - %d", 100, 'a', 99);
	system("pause");
	return 0;
}

上述代码运行结果为：Msg：100 - a - 99

VA_LIST缺陷：

VA_LIST作用一个宏有不少缺点，主要的包括：

1.无法自动获取不定参数的参数类型和数量，只能通过va_arg以规定的格式读取，如果格式不吻合会强制转换。

2.在宏定义中规定了使用VA_LIST时，不定参数不能声明为寄存器变量，或作为函数或数组类型，即定义的函数方法不能传递进数组等参数。