设计变长参数的函数《精通Unix下C语言编程与项目实践》之二

精通Unix下C语言编程与项目实践之二

函数的变长参数

作者：朱云翔，胡平

5.4 函数的变长参数

 

文件的格式化输入输出函数都支持变长参数。定义时，变长参数列表通过省略号“…”表示，因此，具有变长参数列表的函数定义格式为：<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

type 函数名 ( 参数 1, 参数 2, 参数 n, ...);

其中type为函数的返回值类型，参数1～参数n为定长参数，“...”代表变长参数，注意“...”必须定义在参数的最右端。如下例：

int printf(const char *format, ...);

int mysum(...);

5.4.1. 变长参数的使用

Unix的变长参数通过va_list对象实现，定义在文件“stdarg.h”中，变长参数的应用模板如代码5-15所示：

代码5-15 变长参数代码模板

#include <stdarg.h>

function (parmN, ...)

va_list pvar;

……………………………

va_start (pvar, parmN);

while()

{

    ……………………

    f = va_arg (pvar, type);

    ……………………

}

va_end (pvar);

1. va_list pvar

申明va_list数据类型变量pvar，该变量访问变长参数列表中的参数。

2. va_start(pvar, parmN)

宏va_start初始化变长参数列表。pvar是va_list型变量，在步骤1中定义，记载列表中的参数信息。parmN是省略号“...”前的一个参数名，va_start根据此参数，判断参数列表的起始位置，如：

例1. 函数：function(parmN, …)

答：va_start(pvar, parmN);

例2. 函数：int mysum(int i, int j, …)

答：va_start(pvar, j);

3. va_arg(pvar, type)

获取变长参数列表中参数的值。pvar是步骤1中定义的va_list型变量，type为参数值的类型，也是宏va_arg返回数值的类型，如：

va_arg(pvar, int);          /* 将参数列表中的当前参数值转化为int型返回 */

va_arg(pvar, float);        /* 将参数列表中的当前参数值转化为float型返回*/

宏va_arg执行完毕后自动更改对象pvar，将其指向下一个参数。

4. va_end(pvar)

关闭本次对变长参数列表的访问。

实例

设计函数mysum，计算输入参数的和并返回结果。源程序如代码5-16所示：

代码5-16 变长参数函数实例（节自/code/chapter5/mysum.c）

#include <stdarg.h>

int mysum(int i, ...)   /* 参数i表明变长参数的个数 */

{

    int r=0, j=0;

    va_list pvar;

    va_start(pvar, i);

    for (j=0; j<i; j++)

    {

        r += va_arg(pvar, int);

    }

    va_end(pvar);

    return(r);

}

void main()

{

    printf("sum(1,4)=%d\n", mysum(1, 4));

    printf("sum(2,4,8)=%d\n", mysum(2, 4, 8));

}

编译与运行代码5-16：

# make mysum

       cc -O -o mysum mysum.c

# ./mysum

sum(1,4)=4

sum=(2,4,8)=12

5.4.2 变长参数的传递

上一节讲述了如何创建具有变长参数的函数和如何读取变长参数，其操作都在函数内完成，本节将讲述把变长参数列表整体作为参数传递给其他函数的方法。

变长参数传递的函数族如下：

#include <stdarg.h>

int vprintf(const char *format, va_list ap);

int vfprintf(FILE *stream, const char *format, va_list ap);

int vsprintf(char *str, const char *format, va_list ap);

这些函数完全等价于格式化输出函数，只是在形式上采用固定参数代替变长参数，这样描述的函数更加紧凑，这些函数常应用于变长参数函数内部的功能实现。

实例

设计函数“int PrintLog(FILE* stream, const char* pformat, ...)”，它按照字符串format的内容，控制后继参数的数量和格式，并在文件流stream中输出。源程序如代码5-17所示：

代码5-17 传递变长参数实例（节自/code/chapter5/print1.c）

#include <stdarg.h>

#include <stdio.h>

int PrintLog(FILE* pfile, const char * pformat, ...)

{

    va_list _va_list;

    char szBuf[1024];

       if (pformat == NULL || pfile == NULL) return -1;        /* 判断指针是否正确*/

    va_start(_va_list, pformat);                    /* 初始化变长参数列表 */

    vsprintf(szBuf, pformat, _va_list);             /* 传递变长参数 */

    va_end(_va_list);                               /* 结束使用变长参数列表 */

    fputs(szBuf, pfile);                            /* 输出到文件流 */

    return 0;

}

void main()

{

    PrintLog(stderr, "[%s][%s][%d][%c]\n", "This", "Is", 5, 'a');

    PrintLog(stderr, "Error[%p][%.2f][%X]\n", NULL, 3.123, 100);

}

编译与运行代码5-17：

# make print1

        cc -O print1.c  -o print1

# ./print1    

[This][Is][5][a]

Error[00000000][3.12][64]

【实践经验】对于指针类型的参数，最好在函数入口处判断其是否为空，以免空指针引用错误。如代码5-17中黑体部分。

 

相关文章：

封面          前言        目录         策划         作者

动态库        变长参数    文件锁