2. 传入参数与传出参数

如果函数接口有指针参数,既可以把指针所指向的数据传给函数使用(称为传入参数),也可以由函数填充指针所指的内存空间,传回给调用者使用(称为传出参数),例如strcpysrc参数是传入参数,dest参数是传出参数。有些函数的指针参数同时担当了这两种角色,如select(2)fd_set *参数,既是传入参数又是传出参数,这称为Value-result参数。

表 24.1. 传入参数示例:void func(const unit_t *p);

调用者实现者
  1. 分配p所指的内存空间

  2. p所指的内存空间中保存数据

  3. 调用函数

  4. 由于有const限定符,调用者可以确信p所指的内存空间不会被改变

  1. 规定指针参数的类型unit_t *

  2. 读取p所指的内存空间


想一想,如果有函数接口void func(const int p);这里的const有意义吗?

表 24.2. 传出参数示例:void func(unit_t *p);

调用者实现者
  1. 分配p所指的内存空间

  2. 调用函数

  3. 读取p所指的内存空间

  1. 规定指针参数的类型unit_t *

  2. p所指的内存空间中保存数据


表 24.3. Value-result参数示例:void func(unit_t *p);

调用者实现者
  1. 分配p所指的内存空间

  2. p所指的内存空间保存数据

  3. 调用函数

  4. 读取p所指的内存空间

  1. 规定指针参数的类型unit_t *

  2. 读取p所指的内存空间

  3. 改写p所指的内存空间


由于传出参数和Value-result参数的函数接口完全相同,应该在文档中说明是哪种参数。

以下是一个传出参数的完整例子:

例 24.2. 传出参数

/* populator.h */
#ifndef POPULATOR_H
#define POPULATOR_H

typedef struct {
     int number;
     char msg[20];
} unit_t;

extern void set_unit(unit_t *);

#endif
/* populator.c */
#include <string.h>
#include "populator.h"

void set_unit(unit_t *p)
{
     if (p == NULL)
          return; /* ignore NULL parameter */
     p->number = 3;
     strcpy(p->msg, "Hello World!");
}
/* main.c */
#include <stdio.h>
#include "populator.h"

int main(void)
{
     unit_t u;

     set_unit(&u);
     printf("number: %d\nmsg: %s\n", u.number, u.msg);
     return 0;
}

很多系统函数对于指针参数是NULL的情况有特殊规定:如果传入参数是NULL表示取缺省值,例如pthread_create(3)pthread_attr_t *参数,也可能表示不做特别处理,例如free的参数;如果传出参数是NULL表示调用者不需要传出值,例如time(2)的参数。这些特殊规定应该在文档中写清楚。