Skip to content

Latest commit

 

History

History
118 lines (78 loc) · 3.46 KB

nf-shlobj_core-shgetpathfromidlistex.md

File metadata and controls

118 lines (78 loc) · 3.46 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 req.apiset
NF:shlobj_core.SHGetPathFromIDListEx
SHGetPathFromIDListEx function (shlobj_core.h)
Converts an item identifier list to a file system path. This function extends SHGetPathFromIDList by allowing you to set the initial size of the string buffer and declare the options below.
GPFIDL_ALTNAME
GPFIDL_DEFAULT
GPFIDL_UNCPRINTER
SHGetPathFromIDListEx
SHGetPathFromIDListEx function [Windows Shell]
_shell_SHGetPathFromIDListEx
shell.SHGetPathFromIDListEx
shlobj_core/SHGetPathFromIDListEx
shell\SHGetPathFromIDListEx.htm
shell
80270c59-275d-4b13-b16c-0c07bb79ed8e
12/05/2018
GPFIDL_ALTNAME, GPFIDL_DEFAULT, GPFIDL_UNCPRINTER, SHGetPathFromIDListEx, SHGetPathFromIDListEx function [Windows Shell], _shell_SHGetPathFromIDListEx, shell.SHGetPathFromIDListEx, shlobj_core/SHGetPathFromIDListEx
shlobj_core.h
Shlobj.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Shell32.lib
Shell32.dll
Windows
19H1
SHGetPathFromIDListEx
shlobj_core/SHGetPathFromIDListEx
c++
APIRef
kbSyntax
DllExport
Shell32.dll
SHGetPathFromIDListEx
ext-ms-win-shell-shell32-l1-2-2 (introduced in Windows 10, version 10.0.14393)

SHGetPathFromIDListEx function

-description

Converts an item identifier list to a file system path. This function extends SHGetPathFromIDList by allowing you to set the initial size of the string buffer and declare the options below.

-parameters

-param pidl [in]

Type: PCIDLIST_ABSOLUTE

A pointer to an item identifier list that specifies a file or directory location relative to the root of the namespace (the desktop).

-param pszPath [out]

Type: PWSTR

When this function is called it is passed a null-terminated, Unicode buffer to receive the file system path. This buffer is of size cchPath.

When this function returns, contains the address of a null-terminated, Unicode buffer that contains the file system path. This buffer is of size cchPath.

-param cchPath

Type: DWORD

The size of the buffer pointed to by pszPath, in characters.

-param uOpts

Type: GPFIDL_FLAGS

These flags determine the type of path returned.

GPFIDL_DEFAULT (0x0000)

Win32 file names, servers, and root drives are included.

GPFIDL_ALTNAME (0x0001)

Uses short file names.

GPFIDL_UNCPRINTER (0x0002)

Include UNC printer names items.

-returns

Type: BOOL

Returns TRUE if successful; otherwise, FALSE.

-remarks

Except for UNC printer names, if the location specified by the pidl parameter is not part of the file system, this function fails.

If the pidl parameter specifies a shortcut, the pszPath contains the path to the shortcut, not to the shortcut's target.

-see-also

SHParseDisplayName