ホーム › UI.Shell › SHCreateItemFromParsingName

SHCreateItemFromParsingName

関数

解析名からシェルアイテムを作成する。

DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT SHCreateItemFromParsingName(
    LPCWSTR pszPath,
    IBindCtx* pbc,   // optional
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
pszPath	LPCWSTR	in	表示名へのポインター。
pbc	IBindCtx*	inoptional	省略可能。解析関数への入力および出力としてパラメーターを渡すために使用するバインドコンテキストへのポインター。渡されるこれらのパラメーターは、多くの場合データソース固有のものであり、データソースの所有者によって文書化されています。たとえば、ファイルシステムのデータソースは、STR_FILE_SYS_BIND_DATA バインドコンテキストパラメーターを使用して、解析される名前を (WIN32_FIND_DATA 構造体として) 受け取ります。 STR_PARSE_PREFER_FOLDER_BROWSING を渡すと、可能な場合に URL がファイルシステムのデータソースを使用して解析されることを示せます。CreateBindCtx を使用してバインドコンテキストオブジェクトを作成し、IBindCtx::RegisterObjectParam を使用して値を設定します。これらの完全な一覧については、Bind Context String Keys を参照してください。このパラメーターの使用例については、Parsing With Parameters Sample を参照してください。解析関数との間でデータの受け渡しを行わない場合、この値は NULL にできます。
riid	GUID*	in	ppv を通じて取得するインターフェイスの IID への参照。通常は IID_IShellItem または IID_IShellItem2 です。
ppv	void**	out	このメソッドが正常に返ると、riid で要求されたインターフェイスポインターが格納されます。これは通常、IShellItem または IShellItem2 です。

戻り値の型: HRESULT

公式ドキュメント

解析名 (parsing name) から Shell アイテムオブジェクトを作成し、初期化します。

戻り値

型: HRESULT

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

解説(Remarks)

riid パラメーターと ppv パラメーターをまとめるには、Objbase.h で定義されている IID_PPV_ARGS マクロの使用をお勧めします。このマクロは ppv が指す値のインターフェイスに基づいて正しい IID を提供するため、riid のコーディングミスによって予期しない結果が生じる可能性を排除できます。

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

各言語での呼び出し定義

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

HRESULT SHCreateItemFromParsingName(
    LPCWSTR pszPath,
    IBindCtx* pbc,   // optional
    const GUID* riid,
    void** ppv
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHCreateItemFromParsingName(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath,   // LPCWSTR
    IntPtr pbc,   // IBindCtx* optional
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHCreateItemFromParsingName(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String,   ' LPCWSTR
    pbc As IntPtr,   ' IBindCtx* optional
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' pszPath : LPCWSTR
' pbc : IBindCtx* optional
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function SHCreateItemFromParsingName Lib "shell32" ( _
    ByVal pszPath As LongPtr, _
    ByVal pbc As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHCreateItemFromParsingName = ctypes.windll.shell32.SHCreateItemFromParsingName
SHCreateItemFromParsingName.restype = ctypes.c_int
SHCreateItemFromParsingName.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
    ctypes.c_void_p,  # pbc : IBindCtx* optional
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCreateItemFromParsingName = Fiddle::Function.new(
  lib['SHCreateItemFromParsingName'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pbc : IBindCtx* optional
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHCreateItemFromParsingName(
        pszPath: *const u16,  // LPCWSTR
        pbc: *mut core::ffi::c_void,  // IBindCtx* optional
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHCreateItemFromParsingName([MarshalAs(UnmanagedType.LPWStr)] string pszPath, IntPtr pbc, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCreateItemFromParsingName' -Namespace Win32 -PassThru
# $api::SHCreateItemFromParsingName(pszPath, pbc, riid, ppv)

#uselib "SHELL32.dll"
#func global SHCreateItemFromParsingName "SHCreateItemFromParsingName" sptr, sptr, sptr, sptr
; SHCreateItemFromParsingName pszPath, pbc, varptr(riid), ppv   ; 戻り値は stat
; pszPath : LPCWSTR -> "sptr"
; pbc : IBindCtx* optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHCreateItemFromParsingName "SHCreateItemFromParsingName" wstr, sptr, var, sptr
; res = SHCreateItemFromParsingName(pszPath, pbc, riid, ppv)
; pszPath : LPCWSTR -> "wstr"
; pbc : IBindCtx* optional -> "sptr"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHCreateItemFromParsingName "SHCreateItemFromParsingName" wstr, sptr, sptr, sptr
; res = SHCreateItemFromParsingName(pszPath, pbc, varptr(riid), ppv)
; pszPath : LPCWSTR -> "wstr"
; pbc : IBindCtx* optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。