Click to Rate and Give Feedback
MSDN
MSDN Library
System Services
 GetCommandLine Function

  Switch on low bandwidth view
GetCommandLine Function

Retrieves the command-line string for the current process.

Syntax

C++
LPTSTR WINAPI GetCommandLine(void);

Parameters

This function has no parameters.

Return Value

The return value is a pointer to the command-line string for the current process.

Remarks

ANSI console processes written in C can use the argc and argv arguments of the main function to access the command-line arguments. ANSI GUI applications can use the lpCmdLine parameter of the WinMain function to access the command-line string, excluding the program name. The main and WinMain functions cannot return Unicode strings.

Unicode console process written in C can use the wmain or _tmain function to access the command-line arguments. Unicode GUI applications must use the GetCommandLineW function to access Unicode strings.

To convert the command line to an argv style array of strings, call the CommandLineToArgvW function.

Note  The name of the executable in the command line that the operating system provides to a process is not necessarily identical to that in the command line that the calling process gives to the CreateProcess function. The operating system may prepend a fully qualified path to an executable name that is provided without a fully qualified path.

Requirements

Minimum supported clientWindows 2000 Professional
Minimum supported serverWindows 2000 Server
HeaderWinbase.h (include Windows.h)
LibraryKernel32.lib
DLLKernel32.dll
Unicode and ANSI namesGetCommandLineW (Unicode) and GetCommandLineA (ANSI)

See Also

CreateProcess
Process and Thread Functions

Send comments about this topic to Microsoft

Build date: 7/2/2009

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Another way to get the Unicode command line      Yuhong Bao   |   Edit   |   Show History
Another way to get the Unicode command line is to use the wWinMain or wmain function instead of WinMain or main. For ANSI/Unicode portablity use _tWinMain or _tmain.
Tags What's this?: Add a tag
Flag as ContentBug
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker