.\" Copyright (c) 1990, 1991 The Regents of the University of California.
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" @(#)stdarg.3 6.8 (Berkeley) 6/29/91
.Nd variable argument lists
.Fn va_start "va_list ap" last
.Fn va_arg "va_list ap" type
A function may be called with a varying number of arguments of varying
and defines three macros for stepping
through a list of arguments whose number and types are not known to
The called function must declare an object of type
which is used by the macros
and must be called first.
is the name of the last parameter before the variable argument list,
i.e. the last parameter of which the calling function knows the type.
Because the address of this parameter is used in the
macro, it should not be declared as a register variable, or as a
function or an array type.
macro expands to an expression that has the type and value of the next
so that the next call returns the next argument.
is a type name specified so that the type of a pointer to an
object that has the specified type can be obtained simply by
If there is no next argument, or if
is not compatible with the type of the actual next argument
(as promoted according to the default argument promotions),
random errors will occur.
macro returns the argument after
Successive invocations return the values of the remaining
macro handles a normal return from the function whose variable argument
takes a string of format characters and prints out the argument
associated with each format character based on the type.
.Bd -literal -offset indent
printf("string %s\en", s);
compatible with the historic macros they replace.
A backward compatible version can be found in the include
macros do not permit programmers to
code a function with no fixed arguments.
This problem generates work mainly when converting
but it also creates difficulties for variadic functions that
wish to pass all of their arguments on to a function