share/man/man3/stdarg.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)stdarg.3    8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd October 25, 2002
  36 .Dt STDARG 3
  37 .Os
  38 .Sh NAME
  39 .Nm stdarg
  40 .Nd variable argument lists
  41 .Sh SYNOPSIS
  42 .In stdarg.h
  43 .Ft void
  44 .Fn va_start "va_list ap" last
  45 .Ft type
  46 .Fn va_arg "va_list ap" type
  47 .Ft void
  48 .Fn va_copy "va_list dest" "va_list src"
  49 .Ft void
  50 .Fn va_end "va_list ap"
  51 .Sh DESCRIPTION
  52 A function may be called with a varying number of arguments of varying
  53 types.
  54 The include file
  55 .In stdarg.h
  56 declares a type
  57 .Pq Em va_list
  58 and defines four macros for stepping
  59 through a list of arguments whose number and types are not known to
  60 the called function.
  61 .Pp
  62 The called function must declare an object of type
  63 .Em va_list
  64 which is used by the macros
  65 .Fn va_start ,
  66 .Fn va_arg ,
  67 .Fn va_copy ,
  68 and
  69 .Fn va_end .
  70 .Pp
  71 The
  72 .Fn va_start
  73 macro initializes
  74 .Fa ap
  75 for subsequent use by
  76 .Fn va_arg ,
  77 .Fn va_copy ,
  78 and
  79 .Fn va_end ,
  80 and must be called first.
  81 .Pp
  82 The parameter
  83 .Fa last
  84 is the name of the last parameter before the variable argument list,
  85 i.e., the last parameter of which the calling function knows the type.
  86 .Pp
  87 Because the address of this parameter is used in the
  88 .Fn va_start
  89 macro, it should not be declared as a register variable, or as a
  90 function or an array type.
  91 .Pp
  92 The
  93 .Fn va_arg
  94 macro expands to an expression that has the type and value of the next
  95 argument in the call.
  96 The parameter
  97 .Fa ap
  98 is the
  99 .Em va_list Fa ap
 100 initialized by
 101 .Fn va_start
 102 or
 103 .Fn va_copy .
 104 Each call to
 105 .Fn va_arg
 106 modifies
 107 .Fa ap
 108 so that the next call returns the next argument.
 109 The parameter
 110 .Fa type
 111 is a type name specified so that the type of a pointer to an
 112 object that has the specified type can be obtained simply by
 113 adding a *
 114 to
 115 .Fa type .
 116 .Pp
 117 If there is no next argument, or if
 118 .Fa type
 119 is not compatible with the type of the actual next argument
 120 (as promoted according to the default argument promotions),
 121 random errors will occur.
 122 .Pp
 123 The first use of the
 124 .Fn va_arg
 125 macro after that of the
 126 .Fn va_start
 127 macro returns the argument after
 128 .Fa last .
 129 Successive invocations return the values of the remaining
 130 arguments.
 131 .Pp
 132 The
 133 .Fn va_copy
 134 macro copies a variable argument list, previously initialized by
 135 .Fn va_start ,
 136 from
 137 .Fa src
 138 to
 139 .Fa dest .
 140 The state is preserved such that it is equivalent to calling
 141 .Fn va_start
 142 with the same second argument used with
 143 .Fa src ,
 144 and calling
 145 .Fn va_arg
 146 the same number of times as called with
 147 .Fa src .
 148 .Pp
 149 The
 150 .Fn va_end
 151 macro cleans up any state associated with the variable argument list
 152 .Fa ap .
 153 .Pp
 154 Each invocation of
 155 .Fn va_start
 156 or
 157 .Fn va_copy
 158 must be paired with a corresponding invocation of
 159 .Fn va_end
 160 in the same function.
 161 .Sh RETURN VALUES
 162 The
 163 .Fn va_arg
 164 macro returns the value of the next argument.
 165 .Pp
 166 The
 167 .Fn va_start ,
 168 .Fn va_copy ,
 169 and
 170 .Fn va_end
 171 macros return no value.
 172 .Sh EXAMPLES
 173 The function
 174 .Em foo
 175 takes a string of format characters and prints out the argument
 176 associated with each format character based on the type.
 177 .Bd -literal -offset indent
 178 void foo(char *fmt, ...)
 179 {
 180         va_list ap;
 181         int d;
 182         char c, *s;
 183
 184         va_start(ap, fmt);
 185         while (*fmt)
 186                 switch(*fmt++) {
 187                 case 's':                       /* string */
 188                         s = va_arg(ap, char *);
 189                         printf("string %s\en", s);
 190                         break;
 191                 case 'd':                       /* int */
 192                         d = va_arg(ap, int);
 193                         printf("int %d\en", d);
 194                         break;
 195                 case 'c':                       /* char */
 196                         /* Note: char is promoted to int. */
 197                         c = va_arg(ap, int);
 198                         printf("char %c\en", c);
 199                         break;
 200                 }
 201         va_end(ap);
 202 }
 203 .Ed
 204 .Sh COMPATIBILITY
 205 These macros are
 206 .Em not
 207 compatible with the historic macros they replace.
 208 A backward compatible version can be found in the include
 209 file
 210 .In varargs.h .
 211 .Sh STANDARDS
 212 The
 213 .Fn va_start ,
 214 .Fn va_arg ,
 215 .Fn va_copy ,
 216 and
 217 .Fn va_end
 218 macros conform to
 219 .St -isoC-99 .
 220 .Sh BUGS
 221 Unlike the
 222 .Em varargs
 223 macros, the
 224 .Nm
 225 macros do not permit programmers to
 226 code a function with no fixed arguments.
 227 This problem generates work mainly when converting
 228 .Em varargs
 229 code to
 230 .Nm
 231 code,
 232 but it also creates difficulties for variadic functions that
 233 wish to pass all of their arguments on to a function
 234 that takes a
 235 .Em va_list
 236 argument, such as
 237 .Xr vfprintf 3 .