Win32 API 日本語リファレンス
ホームUI.Shell › SHParseDisplayName

SHParseDisplayName

関数
表示名文字列を解析してPIDLに変換する。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

HRESULT SHParseDisplayName(
    LPCWSTR pszName,
    IBindCtx* pbc,   // optional
    ITEMIDLIST** ppidl,
    DWORD sfgaoIn,
    DWORD* psfgaoOut   // optional
);

パラメーター

名前方向
pszNameLPCWSTRin
pbcIBindCtx*inoptional
ppidlITEMIDLIST**out
sfgaoInDWORDin
psfgaoOutDWORD*outoptional

戻り値の型: HRESULT

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

HRESULT SHParseDisplayName(
    LPCWSTR pszName,
    IBindCtx* pbc,   // optional
    ITEMIDLIST** ppidl,
    DWORD sfgaoIn,
    DWORD* psfgaoOut   // optional
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHParseDisplayName(
    [MarshalAs(UnmanagedType.LPWStr)] string pszName,   // LPCWSTR
    IntPtr pbc,   // IBindCtx* optional
    IntPtr ppidl,   // ITEMIDLIST** out
    uint sfgaoIn,   // DWORD
    IntPtr psfgaoOut   // DWORD* optional, out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHParseDisplayName(
    <MarshalAs(UnmanagedType.LPWStr)> pszName As String,   ' LPCWSTR
    pbc As IntPtr,   ' IBindCtx* optional
    ppidl As IntPtr,   ' ITEMIDLIST** out
    sfgaoIn As UInteger,   ' DWORD
    psfgaoOut As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' pszName : LPCWSTR
' pbc : IBindCtx* optional
' ppidl : ITEMIDLIST** out
' sfgaoIn : DWORD
' psfgaoOut : DWORD* optional, out
Declare PtrSafe Function SHParseDisplayName Lib "shell32" ( _
    ByVal pszName As LongPtr, _
    ByVal pbc As LongPtr, _
    ByVal ppidl As LongPtr, _
    ByVal sfgaoIn As Long, _
    ByVal psfgaoOut As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHParseDisplayName = ctypes.windll.shell32.SHParseDisplayName
SHParseDisplayName.restype = ctypes.c_int
SHParseDisplayName.argtypes = [
    wintypes.LPCWSTR,  # pszName : LPCWSTR
    ctypes.c_void_p,  # pbc : IBindCtx* optional
    ctypes.c_void_p,  # ppidl : ITEMIDLIST** out
    wintypes.DWORD,  # sfgaoIn : DWORD
    ctypes.POINTER(wintypes.DWORD),  # psfgaoOut : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHParseDisplayName = Fiddle::Function.new(
  lib['SHParseDisplayName'],
  [
    Fiddle::TYPE_VOIDP,  # pszName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pbc : IBindCtx* optional
    Fiddle::TYPE_VOIDP,  # ppidl : ITEMIDLIST** out
    -Fiddle::TYPE_INT,  # sfgaoIn : DWORD
    Fiddle::TYPE_VOIDP,  # psfgaoOut : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHParseDisplayName(
        pszName: *const u16,  // LPCWSTR
        pbc: *mut core::ffi::c_void,  // IBindCtx* optional
        ppidl: *mut *mut ITEMIDLIST,  // ITEMIDLIST** out
        sfgaoIn: u32,  // DWORD
        psfgaoOut: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHParseDisplayName([MarshalAs(UnmanagedType.LPWStr)] string pszName, IntPtr pbc, IntPtr ppidl, uint sfgaoIn, IntPtr psfgaoOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHParseDisplayName' -Namespace Win32 -PassThru
# $api::SHParseDisplayName(pszName, pbc, ppidl, sfgaoIn, psfgaoOut)
#uselib "SHELL32.dll"
#func global SHParseDisplayName "SHParseDisplayName" sptr, sptr, sptr, sptr, sptr
; SHParseDisplayName pszName, pbc, varptr(ppidl), sfgaoIn, varptr(psfgaoOut)   ; 戻り値は stat
; pszName : LPCWSTR -> "sptr"
; pbc : IBindCtx* optional -> "sptr"
; ppidl : ITEMIDLIST** out -> "sptr"
; sfgaoIn : DWORD -> "sptr"
; psfgaoOut : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHParseDisplayName "SHParseDisplayName" wstr, sptr, var, int, var
; res = SHParseDisplayName(pszName, pbc, ppidl, sfgaoIn, psfgaoOut)
; pszName : LPCWSTR -> "wstr"
; pbc : IBindCtx* optional -> "sptr"
; ppidl : ITEMIDLIST** out -> "var"
; sfgaoIn : DWORD -> "int"
; psfgaoOut : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHParseDisplayName(LPCWSTR pszName, IBindCtx* pbc, ITEMIDLIST** ppidl, DWORD sfgaoIn, DWORD* psfgaoOut)
#uselib "SHELL32.dll"
#cfunc global SHParseDisplayName "SHParseDisplayName" wstr, intptr, var, int, var
; res = SHParseDisplayName(pszName, pbc, ppidl, sfgaoIn, psfgaoOut)
; pszName : LPCWSTR -> "wstr"
; pbc : IBindCtx* optional -> "intptr"
; ppidl : ITEMIDLIST** out -> "var"
; sfgaoIn : DWORD -> "int"
; psfgaoOut : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHParseDisplayName = shell32.NewProc("SHParseDisplayName")
)

// pszName (LPCWSTR), pbc (IBindCtx* optional), ppidl (ITEMIDLIST** out), sfgaoIn (DWORD), psfgaoOut (DWORD* optional, out)
r1, _, err := procSHParseDisplayName.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszName))),
	uintptr(pbc),
	uintptr(ppidl),
	uintptr(sfgaoIn),
	uintptr(psfgaoOut),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHParseDisplayName(
  pszName: PWideChar;   // LPCWSTR
  pbc: Pointer;   // IBindCtx* optional
  ppidl: Pointer;   // ITEMIDLIST** out
  sfgaoIn: DWORD;   // DWORD
  psfgaoOut: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHParseDisplayName';
result := DllCall("SHELL32\SHParseDisplayName"
    , "WStr", pszName   ; LPCWSTR
    , "Ptr", pbc   ; IBindCtx* optional
    , "Ptr", ppidl   ; ITEMIDLIST** out
    , "UInt", sfgaoIn   ; DWORD
    , "Ptr", psfgaoOut   ; DWORD* optional, out
    , "Int")   ; return: HRESULT
●SHParseDisplayName(pszName, pbc, ppidl, sfgaoIn, psfgaoOut) = DLL("SHELL32.dll", "int SHParseDisplayName(char*, void*, void*, dword, void*)")
# 呼び出し: SHParseDisplayName(pszName, pbc, ppidl, sfgaoIn, psfgaoOut)
# pszName : LPCWSTR -> "char*"
# pbc : IBindCtx* optional -> "void*"
# ppidl : ITEMIDLIST** out -> "void*"
# sfgaoIn : DWORD -> "dword"
# psfgaoOut : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。