Skip to content

Latest commit

 

History

History
121 lines (78 loc) · 3.43 KB

nf-shlobj-pathprocesscommand.md

File metadata and controls

121 lines (78 loc) · 3.43 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:shlobj.PathProcessCommand
PathProcessCommand function (shlobj.h)
Deprecated. Processes a string that contains a command line and generates a suitably quoted string, with arguments attached if required.
PPCF_ADDARGUMENTS
PPCF_ADDQUOTES
PPCF_FORCEQUALIFY
PPCF_LONGESTPOSSIBLE
PPCF_NODIRECTORIES
PathProcessCommand
PathProcessCommand function [Windows Shell]
_win32_PathProcessCommand
shell.PathProcessCommand
shlobj/PathProcessCommand
shell\PathProcessCommand.htm
shell
9dbc39e7-f73b-450f-bb87-17a38e7ab66d
12/05/2018
PPCF_ADDARGUMENTS, PPCF_ADDQUOTES, PPCF_FORCEQUALIFY, PPCF_LONGESTPOSSIBLE, PPCF_NODIRECTORIES, PathProcessCommand, PathProcessCommand function [Windows Shell], _win32_PathProcessCommand, shell.PathProcessCommand, shlobj/PathProcessCommand
shlobj.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Shell32.lib
Shell32.dll (version 5.0 or later)
Windows
19H1
PathProcessCommand
shlobj/PathProcessCommand
c++
APIRef
kbSyntax
DllExport
Shell32.dll
PathProcessCommand

PathProcessCommand function

-description

Deprecated. Processes a string that contains a command line and generates a suitably quoted string, with arguments attached if required.

-parameters

-param pszSrc [in]

Type: PCWSTR

A pointer to a null-terminated string that contains the command line to process.

-param pszDest [out]

Type: PWSTR

Pointer to a buffer that receives a null-terminated Unicode string with the appropriate quotation marks. To determine how large this buffer must be, set this parameter to NULL. The function returns the required buffer size.

-param cchDest

Type: int

The maximum number of characters that can be put in pszDest, not including the terminating null character. If this value is too small, the function fails.

-param dwFlags

Type: DWORD

Flags that control the procedure. One or more of the following values:

PPCF_ADDQUOTES (0x00000001)

Add quotes if the path requires them.

PPCF_ADDARGUMENTS (0x00000003)

Append trailing arguments to the output string. This value includes PPCF_ADDQUOTES.

PPCF_NODIRECTORIES (0x00000010)

Do not match the input string against folders, only against file objects.

PPCF_FORCEQUALIFY (0x00000040)

Qualify even non-relative file names.

PPCF_LONGESTPOSSIBLE (0x00000080)

Always choose the longest possible executable name.

-returns

Type: LONG

Returns a positive value if successful. If lpDest is set to NULL, the function returns the required buffer size in characters, including the terminating null character. If the call fails, the function returns a negative value.

-remarks

Note  This function is available through Windows XP Service Pack 2 (SP2) and Windows Server 2003. It is not supported in Windows Vista and later versions of Windows.