windows_programming_notes.nbk: Home | Index | Next Page: CommDlgExtendedError | Previous Page: COM in plain C Series

 CommandLineToArgvW

The CommandLineToArgvW function parses a Unicode command-line string. It returns a pointer to a set of 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.

Syntax

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

Parameters

• lpCmdLine
  [in] Pointer to a null-terminated Unicode command-line string. An application will usually directly pass on the value returned by a call to the GetCommandLine function. If this parameter is the empty string, "", the function returns the path to the current executable file.
• pNumArgs
  [out] Pointer to an integer variable that receives 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 an array of Unicode 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 the GlobalFree function.

Requirements

• Windows NT/2000 or later: Requires Windows NT 3.5 or later.
• Windows 95/98/Me: Unsupported.
• Header: Declared in Shellapi.h; include Windows.h.
• Library: Use Shell32.lib.
• Unicode: Implemented only as Unicode.

windows_programming_notes.nbk: Home | Index | Next Page: CommDlgExtendedError | Previous Page: COM in plain C Series

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time