ホーム › 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
);

パラメーター

名前	型	方向	説明
pszName	LPCWSTR	in	解析する表示名を格納した、ゼロ終端のワイド文字列へのポインターです。
pbc	IBindCtx*	inoptional	解析操作を制御するバインドコンテキストです。このパラメーターは通常 NULL に設定します。
ppidl	ITEMIDLIST**	out	オブジェクトのアイテム識別子リストを受け取る、ITEMIDLIST 型の変数へのポインターのアドレスです。エラーが発生した場合、このパラメーターは NULL に設定されます。
sfgaoIn	DWORD	in	クエリする属性を指定する ULONG 値です。1 つ以上の属性をクエリするには、対象とする属性を表すフラグでこのパラメーターを初期化します。使用可能な SFGAO フラグの一覧については、SFGAO を参照してください。
psfgaoOut	DWORD*	outoptional	ULONG へのポインターです。戻り時に、オブジェクトに対して真であり、かつ sfgaoIn で要求された属性が設定されます。オブジェクトの属性フラグは、ゼロまたは SFGAO フラグの組み合わせになります。使用可能な SFGAO フラグの一覧については、SFGAO を参照してください。

戻り値の型: HRESULT

公式ドキュメント

Shell 名前空間オブジェクトの表示名をアイテム識別子リストに変換し、そのオブジェクトの属性を返します。この関数は、文字列をアイテム識別子リスト (PIDL) へのポインターに変換するための推奨される方法です。

戻り値

Type: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

この関数はバックグラウンドスレッドから呼び出す必要があります。そうしない場合、UI が応答しなくなる可能性があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHParseDisplayName "SHParseDisplayName" wstr, sptr, sptr, int, sptr
; res = SHParseDisplayName(pszName, pbc, varptr(ppidl), sfgaoIn, varptr(psfgaoOut))
; pszName : LPCWSTR -> "wstr"
; pbc : IBindCtx* optional -> "sptr"
; ppidl : ITEMIDLIST** out -> "sptr"
; sfgaoIn : DWORD -> "int"
; psfgaoOut : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。