Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

varargs(5) [ultrix man page]

varargs(5)							File Formats Manual							varargs(5)

Name
       varargs - handle variable argument list

Syntax
       #include <varargs.h>

       va_alist

       va_dcl

       void va_start(pvar)
       va_list pvar;

       type va_arg(pvar, type)
       va_list pvar;

       void va_end(pvar)
       va_list pvar;

Description
       This  set  of  macros  allows  portable procedures that accept variable argument lists to be written.  Routines that have variable argument
       lists, such as but that do not use are inherently nonportable, as different machines use different argument-passing conventions.

       va_alist  Is used as the parameter list in a function header.

       va_dcl	 Is a declaration for va_alist.  A semicolon should not follow va_dcl.

       va_list	 Is a type defined for the variable used to traverse the list.

       va_start  Is called to initialize pvar to the beginning of the list.

       va_arg	 Returns the next argument in the list pointed to by pvar.  Type Is the type the argument is expected to be.  Different types  can
		 be  mixed,  but  it  is up to the routine to know what type of argument is expected. This information cannot be determined at run
		 time.

       va_end	 is used to clean up.

       Multiple traversals, each bracketed by va_start ...  va_end, are possible.

       The calling routine must specify how many arguments there are, because it is not always possible to determine this from	the  stack  frame.
       For example, is passed a zero pointer to signal the end of the list.  The routine can tell how many arguments there are by the format.

       It  is  nonportable  to specify a second argument of char, short, or float to va_arg, because arguments seen by the called function are not
       char, short, or float.  C converts char and short arguments to int and converts float arguments to double before passing them  to  a  func-
       tion.

Examples
       The following example presents an implementation of

	    #include <varargs.h>
	    #define MAXARGS	100

	    /*	 execl is called by
		      execl(file, arg1, arg2, ..., (char *)0);
	    */
	    execl(va_alist)
	    va_dcl
	    {
		 va_list ap;
		 char *file;
		 char *args[MAXARGS];
		 int argno = 0;

		 va_start(ap);
		 file = va_arg(ap, char *);
		 while ((args[argno++] = va_arg(ap, char *)) != (char *)0)
		      ;
		 va_end(ap);
		 return execv(file, args);
	    }

See Also
       exec(2), printf(3s), vprintf(3s)

								       RISC								varargs(5)

Check Out this Related Man Page

varargs(3EXT)						    Extended Library Functions						     varargs(3EXT)

NAME
varargs - handle variable argument list SYNOPSIS
#include <varargs.h> va_alist va_dcl va_list pvar; void va_start(va_listpvar); type va_arg(va_list pvar, type); void va_end(va_list pvar); DESCRIPTION
This set of macros allows portable procedures that accept variable argument lists to be written. Routines that have variable argument lists (such as printf(3C)) but do not use varargs are inherently non-portable, as different machines use different argument-passing conventions. va_alist is used as the parameter list in a function header. va_dcl is a declaration for va_alist. No semicolon should follow va_dcl. va_list is a type defined for the variable used to traverse the list. va_start is called to initialize pvar to the beginning of the list. va_arg will return the next argument in the list pointed to by pvar. type is the type the argument is expected to be. Different types can be mixed, but it is up to the routine to know what type of argument is expected, as it cannot be determined at runtime. va_end is used to clean up. Multiple traversals, each bracketed by va_start and va_end, are possible. EXAMPLES
Example 1: A sample program. This example is a possible implementation of execl (see exec(2) ). #include <unistd.h> #include <varargs.h> #define MAXARGS 100 /* execl is called by execl(file, arg1, arg2, ..., (char *)0); */ execl(va_alist) va_dcl { va_list ap; char *file; char *args[MAXARGS]; /* assumed big enough*/ int argno = 0; va_start(ap); file = va_arg(ap, char *); while ((args[argno++] = va_arg(ap, char *)) != 0) ; va_end(ap); return execv(file, args); } SEE ALSO
exec(2), printf(3C), vprintf(3C), stdarg(3EXT) NOTES
It is up to the calling routine to specify in some manner how many arguments there are, since it is not always possible to determine the number of arguments from the stack frame. For example, execl is passed a zero pointer to signal the end of the list. printf can tell how many arguments are there by the format. It is non-portable to specify a second argument of char, short, or float to va_arg, since arguments seen by the called function are not char, short, or float. C converts char and short arguments to int and converts float arguments to double before passing them to a function. stdarg is the preferred interface. SunOS 5.10 10 May 2002 varargs(3EXT)
Man Page

Featured Tech Videos