stdarg - ライブラリコールの説明 - Linux コマンド集 一覧表

stdarg - 個数・型が可変な引数リスト

#include <stdarg.h>
void va_start(va_list ap , last );
type va_arg(va_list ap , type );
void va_end(va_list ap );
void va_copy(va_list dest , va_list src );

関数は呼び出しに際して、個数や型が可変な引数をとることができる。 インクルードファイル <stdarg.h> では va_list 型が宣言されており、3 つのマクロが定義されている。これらを用いると、 呼び出された関数側では個数や型を知らない引き数のリストを、順に一 つづつ読み込むことができる。

呼び出される関数では、 va_list 型のオブジェクトが宣言されていなければならない。このオブジェクトが va_start (), va_arg (), va_end ()の各マクロによって扱われる。

va_start

va_arg

va_end

va_copy

	va_list aq = ap;

	va_list aq;
	*aq = *ap;

	va_list aq;
	va_copy(aq, ap);
	...
	va_end(aq);

関数 foo は書式文字からなる文字列を受け入れ、その書式文字に対応する型で可変個の 引き数を読み込み、印字する。

#include <stdio.h>
#include <stdarg.h>



void foo(char *fmt, ...) {
	va_list ap;
	int d;
	char c, *s;



	va_start(ap, fmt);
	while (*fmt)
		switch(*fmt++) {
		case 's':			/* string */
			s = va_arg(ap, char *);
			printf("string %s\n", s);
			break;
		case 'd':			/* int */
			d = va_arg(ap, int);
			printf("int %d\n", d);
			break;
		case 'c':			/* char */
			/* need a cast here since va_arg only
			   takes fully promoted types */
			c = (char) va_arg(ap, int);
			printf("char %c\n", c);
			break;
		}
	va_end(ap);
}

va_start (), va_arg (), va_end ()マクロは C89 準拠である。 va_copy ()は C99 で定義されている。

これらのマクロは、以前から用いられてきた同等のマクロ群と 互換ではない 。過去のものと互換なバージョンは、 インクルードファイル varargs.h に存在する。

歴史的なセットアップは以下のとおりである。

#include <varargs.h>



void foo(va_alist) va_dcl {
	va_list ap;



	va_start(ap);
	while(...) {
		...
		x = va_arg(ap, type);
		...
	}
	va_end(ap);
}

varargs マクロとは異なり、 stdarg マクロでは固定引き数なしで関数を指定することが許されていない。 これは varargs ベースのコードを stdarg のコードに書き換えるときに、面倒な作業のもとになる。 また、すべての引き数を va_list として可変個指定したいような場合 ( vfprintf (3)など) にも障害となる。