ホーム › UI.Shell.PropertiesSystem › PSGetItemPropertyHandlerWithCreateObject

PSGetItemPropertyHandlerWithCreateObject

関数

オブジェクト生成指定で項目のプロパティハンドラを取得する。

DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PSGetItemPropertyHandlerWithCreateObject(
    IUnknown* punkItem,
    BOOL fReadWrite,
    IUnknown* punkCreateObject,
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
punkItem	IUnknown*	in	IShellItem をサポートする Shell アイテムの IUnknown インターフェイスへのポインター。 Windows XP: Shell アイテムの作成には SHCreateShellItem を使用します。 Windows Vista: Shell アイテムの作成には SHCreateItemFromIDList、SHCreateItemFromParsingName、SHCreateItemFromRelativeName、SHCreateItemInKnownFolder、または SHCreateItemWithParent を使用します。
fReadWrite	BOOL	in	読み取り/書き込みのプロパティハンドラーを取得する場合は TRUE。読み取り専用のプロパティハンドラーを取得する場合は FALSE。
punkCreateObject	IUnknown*	in	ICreateObject をサポートするクラスファクトリオブジェクトの IUnknown インターフェイスへのポインター。
riid	GUID*	in	ppv を通じて取得するインターフェイスの IID への参照。
ppv	void**	out	この関数が正常に終了すると、riid で要求されたインターフェイスポインターが格納されます。通常は IPropertyStore または IPropertyStoreCapabilities です。

戻り値の型: HRESULT

公式ドキュメント

Shell アイテムのプロパティハンドラーを取得します。(PSGetItemPropertyHandlerWithCreateObject)

戻り値

型: PSSTDAPI

成功した場合は S_OK を返します。それ以外の場合はエラー値を返します。

解説(Remarks)

この関数は、IPropertyStore とその関連インターフェイスを含む Microsoft Windows Desktop Search (WDS) 再頒布可能パッケージの一部として、Windows XP でサポートされます。Windows Vista 以降でのみサポートされるアプリケーションでは、PSGetItemPropertyHandlerWithCreateObject ではなく IShellItem2::GetPropertyStoreWithCreateObject を使用することをお勧めします。IShellItem2::GetPropertyStoreWithCreateObject は、返されるプロパティストアでより豊富なプロパティのセットを提供するためです。

この関数は、IShellItem2::GetPropertyStoreWithCreateObject に GPS_HANDLERPROPERTIESONLY フラグを渡す場合とほぼ同等です。

punkCreateObject パラメーターを使用すると、呼び出し元とは異なるコンテキストでプロパティストアを作成できます。たとえば、ICreateObject の実装によって、別のプロセスでプロパティストアを作成させることができます。このパラメーターは、これをサポートしており、かつ HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\PropertySystem\PropertyHandlers の下に登録されているプロパティハンドラーに対してのみ使用されます。

PSGetItemPropertyHandlerWithCreateObject を呼び出す前に、CoInitialize または OleInitialize でコンポーネントオブジェクトモデル (COM) を初期化する必要があります。COM は、このオブジェクトの有効期間中、初期化されたままである必要があります。

例

次の例は、より大きなプログラムの一部として組み込むことを想定したもので、PSGetItemPropertyHandlerWithCreateObject を使用してアイテムのプロパティハンドラーを取得する方法を示しています。

// IShellItem *psi;
// ICreateObject *pco;
// 変数 pco と psi は有効で初期化済みであると仮定します。
IPropertyStore *pStore;

HRESULT hr = PSGetItemPropertyHandlerWithCreateObject(psi, FALSE, pco, IID_PPV_ARGS(&pStore));

if (SUCCEEDED(hr))
{
    // pStore は有効になり、そのアイテムのプロパティハンドラーを通じて
    // 公開されるプロパティが格納されています。
 
    pStore->Release();
}

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

各言語での呼び出し定義

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

HRESULT PSGetItemPropertyHandlerWithCreateObject(
    IUnknown* punkItem,
    BOOL fReadWrite,
    IUnknown* punkCreateObject,
    const GUID* riid,
    void** ppv
);

[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PSGetItemPropertyHandlerWithCreateObject(
    IntPtr punkItem,   // IUnknown*
    bool fReadWrite,   // BOOL
    IntPtr punkCreateObject,   // IUnknown*
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PSGetItemPropertyHandlerWithCreateObject(
    punkItem As IntPtr,   ' IUnknown*
    fReadWrite As Boolean,   ' BOOL
    punkCreateObject As IntPtr,   ' IUnknown*
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' punkItem : IUnknown*
' fReadWrite : BOOL
' punkCreateObject : IUnknown*
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function PSGetItemPropertyHandlerWithCreateObject Lib "propsys" ( _
    ByVal punkItem As LongPtr, _
    ByVal fReadWrite As Long, _
    ByVal punkCreateObject 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

PSGetItemPropertyHandlerWithCreateObject = ctypes.windll.propsys.PSGetItemPropertyHandlerWithCreateObject
PSGetItemPropertyHandlerWithCreateObject.restype = ctypes.c_int
PSGetItemPropertyHandlerWithCreateObject.argtypes = [
    ctypes.c_void_p,  # punkItem : IUnknown*
    wintypes.BOOL,  # fReadWrite : BOOL
    ctypes.c_void_p,  # punkCreateObject : IUnknown*
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
PSGetItemPropertyHandlerWithCreateObject = Fiddle::Function.new(
  lib['PSGetItemPropertyHandlerWithCreateObject'],
  [
    Fiddle::TYPE_VOIDP,  # punkItem : IUnknown*
    Fiddle::TYPE_INT,  # fReadWrite : BOOL
    Fiddle::TYPE_VOIDP,  # punkCreateObject : IUnknown*
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "propsys")]
extern "system" {
    fn PSGetItemPropertyHandlerWithCreateObject(
        punkItem: *mut core::ffi::c_void,  // IUnknown*
        fReadWrite: i32,  // BOOL
        punkCreateObject: *mut core::ffi::c_void,  // IUnknown*
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("PROPSYS.dll")]
public static extern int PSGetItemPropertyHandlerWithCreateObject(IntPtr punkItem, bool fReadWrite, IntPtr punkCreateObject, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PROPSYS_PSGetItemPropertyHandlerWithCreateObject' -Namespace Win32 -PassThru
# $api::PSGetItemPropertyHandlerWithCreateObject(punkItem, fReadWrite, punkCreateObject, riid, ppv)

#uselib "PROPSYS.dll"
#func global PSGetItemPropertyHandlerWithCreateObject "PSGetItemPropertyHandlerWithCreateObject" sptr, sptr, sptr, sptr, sptr
; PSGetItemPropertyHandlerWithCreateObject punkItem, fReadWrite, punkCreateObject, varptr(riid), ppv   ; 戻り値は stat
; punkItem : IUnknown* -> "sptr"
; fReadWrite : BOOL -> "sptr"
; punkCreateObject : IUnknown* -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "PROPSYS.dll"
#cfunc global PSGetItemPropertyHandlerWithCreateObject "PSGetItemPropertyHandlerWithCreateObject" sptr, int, sptr, var, sptr
; res = PSGetItemPropertyHandlerWithCreateObject(punkItem, fReadWrite, punkCreateObject, riid, ppv)
; punkItem : IUnknown* -> "sptr"
; fReadWrite : BOOL -> "int"
; punkCreateObject : IUnknown* -> "sptr"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "PROPSYS.dll"
#cfunc global PSGetItemPropertyHandlerWithCreateObject "PSGetItemPropertyHandlerWithCreateObject" sptr, int, sptr, sptr, sptr
; res = PSGetItemPropertyHandlerWithCreateObject(punkItem, fReadWrite, punkCreateObject, varptr(riid), ppv)
; punkItem : IUnknown* -> "sptr"
; fReadWrite : BOOL -> "int"
; punkCreateObject : IUnknown* -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。