CommandLineToArgvW - Win32 Programmer's Reference (win32.hlp)

Win32 Programmer's Reference

Index Commented Search About

Overview

Group

Quick Info

Windows NT
Yes
Win95
No
Win32s
Yes
Import Library
shell32.lib
Header File
shellapi.h
Unicode
No
Platform Notes
None

CommandLineToArgvW

The CommandLineToArgvW function parses a wide-character Unicode command-line string. It returns a pointer to a set of wide-character Unicode argument strings and a count of arguments, similar to the standard C run-time argv and argc values. The function provides a way to obtain a Unicode set of argv and argc values from a Unicode command-line string.

LPWSTR * CommandLineToArgvW(

LPCWSTR lpCmdLine,	// pointer to a command-line string
int *pNumArgs	// pointer to a variable that receives the argument count
);

Parameters
lpCmdLine

Pointer to a null-terminated Unicode command-line string. An application will usually directly pass on the value returned by a call to GetCommandLineW.

pNumArgs

Pointer to an integer variable that the function sets to the count of arguments parsed.

Return Values
If the function succeeds, the return value is a non-NULL pointer to the constructed argument list, which is a set of Unicode wide-character argument strings.

If the function fails, the return value is NULL. To get extended error information, call GetLastError.

Remarks
It is the caller's responsibility to free the memory used by the argument list when it is no longer needed. To free the memory, use a single call to either the GlobalFree or LocalFree function.

See Also
GetCommandLine, GlobalFree, LocalFree

More Online Helps

Win32 Multimedia Programmer's Reference (mmedia.hlp)
OLE Programmer's Reference (ole.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (tapi.hlp)
Unix Manual Pages

greatis just4fun network