__getmainargs, __wgetmainargs

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at __getmainargs, __wgetmainargs.

Invokes command-line parsing and copies the arguments to main() back through the passed pointers.

int __getmainargs(  
    int * _Argc,   
   char *** _Argv,   
   char *** _Env,   
   int _DoWildCard,  
_startupinfo * _StartInfo);  
  
 int __wgetmainargs (  
   int *_Argc,  
   wchar_t ***_Argv,  
   wchar_t ***_Env,  
   int _DoWildCard,  
   _startupinfo * _StartInfo)  
  

Parameters

_Argc
An integer that contains the number of arguments that follow in argv. The argc parameter is always greater than or equal to 1.

_Argv
An array of null-terminated strings representing command-line arguments entered by the user of the program. By convention, argv[0] is the command with which the program is invoked, argv[1] is the first command-line argument, and so on, until argv[argc], which is always NULL. The first command-line argument is always argv[1] and the last one is argv[argc – 1].

_Env
An array of strings that represent the variables set in the user's environment. This array is terminated by a NULL entry.

_DoWildCard
An integer that if set to 1 expands the wildcards in the command line arguments, or if set to 0 does nothing.

_StartInfo
Other information to be passed to the CRT DLL.

0 if successful; a negative value if unsuccessful.

Use __getmainargs on non-wide character platforms, and __wgetmainargs on wide-character (Unicode) platforms.