ホーム › UI.Shell.PropertiesSystem › PSCreateDelayedMultiplexPropertyStore

PSCreateDelayedMultiplexPropertyStore

関数

遅延読み込み対応の多重プロパティストアを生成する。

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

シグネチャ

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

HRESULT PSCreateDelayedMultiplexPropertyStore(
    GETPROPERTYSTOREFLAGS flags,
    IDelayedPropertyStoreFactory* pdpsf,
    const DWORD* rgStoreIds,
    DWORD cStores,
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
flags	GETPROPERTYSTOREFLAGS	in	1 つ以上の GETPROPERTYSTOREFLAGS 値。これらの値は、作成されるプロパティストアオブジェクトの詳細を指定します。
pdpsf	IDelayedPropertyStoreFactory*	in	IDelayedPropertyStoreFactory のインスタンスへのインターフェイスポインター。
rgStoreIds	DWORD*	in	プロパティストア ID の配列へのポインター。この配列は初期化されている必要はありません。
cStores	DWORD	in	rgStoreIds が指す配列の要素数。
riid	GUID*	in	作成されるプロパティストアを表すインターフェイスの、要求する IID への参照。
ppv	void**	out	この関数から制御が戻ったとき、riid で要求されたインターフェイスポインターが格納されます。通常は IPropertyStore です。

戻り値の型: HRESULT

公式ドキュメント

複数のプロパティストアを含む、読み取り専用の遅延バインディングプロパティストアを作成します。

戻り値

型: HRESULT

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

解説(Remarks)

この関数は、IPropertyStore、 INamedPropertyStore、IObjectProvider、IPropertyStoreCapabilities を実装するコンポーネントオブジェクトモデル (COM) オブジェクトを作成します。

アプリケーションは、このオブジェクトを一度に 1 つのスレッドからのみ呼び出す必要があります。

PSCreateDelayedMultiplexPropertyStore を呼び出す前に、CoInitialize または OleInitialize によって COM を初期化しておく必要があります。COM は、このオブジェクトが存在する間、初期化された状態を保つ必要があります。

PSCreateDelayedMultiplexPropertyStore は、PSCreateMultiplexPropertyStore の代替として設計されています。後者は、多重化プロパティストアを作成する前にプロパティストアの配列が初期化されていることを必要とします。

遅延バインディングの仕組みは、多重化プロパティストアに対する IPropertyStore::GetValue の呼び出しのパフォーマンスを向上させるために設計されています。プロパティの値を要求されると、遅延多重化プロパティストアは各プロパティストアで値を確認します。値が見つかった後は、それ以降のストアを作成して初期化する必要はありません。遅延多重化プロパティストアは、いずれかのプロパティストアが成功コードと VT_EMPTY 以外の値を返した時点で、値の検索を停止します。

遅延多重化プロパティストアは、特定のプロパティストアにアクセスする必要が生じると、まずそのプロパティストアへのインターフェイスを既に取得しているかどうかを確認します。取得していない場合は、該当するプロパティストア ID を指定して IDelayedPropertyStoreFactory::GetDelayedPropertyStore を呼び出し、プロパティストアを取得します。プロパティストア ID は、常にアプリケーションが指定した順序で使用されます。すべての ID が使用されるとは限りません。

特定のプロパティストア ID に対する IDelayedPropertyStoreFactory の呼び出しが E_NOTIMPL または E_ACCESSDENIED で失敗した場合、あるいはアプリケーションが GPS_BESTEFFORT を指定していた場合、その失敗は無視され、遅延多重化プロパティストアは次のプロパティストアに進みます。

場合によっては、PSCreateMultiplexPropertyStore の代わりに PSCreateDelayedMultiplexPropertyStore を使用すると有益なことがあります。たとえば、アプリケーションが 2 つのプロパティストアを多重化する必要があり、最初のプロパティストアは初期化時のメモリ消費が少なく、PKEY_Size の情報を提供する場合です。呼び出し側のアプリケーションは、多重化プロパティストアを要求した後、オブジェクトを解放するまでに PKEY_Size だけを要求することがよくあります。このような場合、アプリケーションは PSCreateDelayedMultiplexPropertyStore を呼び出して IDelayedPropertyStoreFactory を実装することで、2 番目のプロパティストアを初期化するコストを回避できます。

例

次の例は、より大きなプログラムの一部として組み込むことを想定したもので、IPropertyStoreFactory::GetPropertyStore の実装で PSCreateDelayedMultiplexPropertyStore を使用する方法を示しています。

// CMyFactory is a reference-counted COM object that implements both IPropertyStoreFactory and IDelayedPropertyStoreFactory.

// CMyFactory is assumed to be fully implemented, but for the sake of brevity, 
// many functions are not shown here. 

// Private functions are indicated with an underscore prefix.

// The hope is that the fastest property store satisfies the caller's queries 
// so that the slower property stores are never created.
 
// CMyFactory implementation for IPropertyStoreFactory::GetPropertyStore
HRESULT CMyFactory::GetPropertyStore( __in GETPROPERTYSTOREFLAGS flags,
                                      __in_opt IUnknown *pUnkFactory,
                                      __in REFIID riid,
                                      __deref_out void **ppv)
{
    *ppv = NULL;
    HRESULT hr;
 
    // This application creates only read-only stores.
    if (flags & GPS_READWRITE)
    {
        hr = STG_E_ACCESSDENIED;
    }
    else
    {
        // More advanced applications would check other GETPROPERTYSTOREFLAGS 
        // flags and respond appropriately.
 
        // This application always creates its stores in-process, so it 
        // ignores the pUnkFactory value.
        
        DWORD rgStoreIds[] = {0, 1, 2};
        
        hr = PSCreateDelayedMultiplexPropertyStore(flags, this, rgStoreIds, ARRAYSIZE(rgStoreIds), riid, ppv);
    }
 
    return hr;
}
 
// CMyFactory implementation of IDelayedPropertyStoreFactory::GetDelayedPropertyStore
HRESULT CMyFactory::GetDelayedPropertyStore(GETPROPERTYSTOREFLAGS flags,
                                            DWORD dwStoreId,
                                            REFIID riid,
                                            void **ppv)
{
    *ppv = NULL;
    HRESULT hr;
    
    // Note: The IDs here match the IDs in rgStoreIds above.

    if (dwStoreId == 0)
    {
        // This store is the fastest at returning properties.

        hr = _CreateFastestPropertyStore(flags, riid, ppv);
    }
    else if (dwStoreId == 1)
    {
        // This store is slower at returning properties.
        hr = _CreateSlowerPropertyStore(flags, riid, ppv);
    }
    else if (dwStoreId == 2)
    {
        // This store is very slow at returning properties.
        hr = _CreateSlowestPropertyStore(flags, riid, ppv);
    }
    else
    {
        // This should never happen.
        hr = E_UNEXPECTED;
    }
    
    return hr;
}

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

各言語での呼び出し定義

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

HRESULT PSCreateDelayedMultiplexPropertyStore(
    GETPROPERTYSTOREFLAGS flags,
    IDelayedPropertyStoreFactory* pdpsf,
    const DWORD* rgStoreIds,
    DWORD cStores,
    const GUID* riid,
    void** ppv
);

[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PSCreateDelayedMultiplexPropertyStore(
    int flags,   // GETPROPERTYSTOREFLAGS
    IntPtr pdpsf,   // IDelayedPropertyStoreFactory*
    ref uint rgStoreIds,   // DWORD*
    uint cStores,   // DWORD
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PSCreateDelayedMultiplexPropertyStore(
    flags As Integer,   ' GETPROPERTYSTOREFLAGS
    pdpsf As IntPtr,   ' IDelayedPropertyStoreFactory*
    ByRef rgStoreIds As UInteger,   ' DWORD*
    cStores As UInteger,   ' DWORD
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' flags : GETPROPERTYSTOREFLAGS
' pdpsf : IDelayedPropertyStoreFactory*
' rgStoreIds : DWORD*
' cStores : DWORD
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function PSCreateDelayedMultiplexPropertyStore Lib "propsys" ( _
    ByVal flags As Long, _
    ByVal pdpsf As LongPtr, _
    ByRef rgStoreIds As Long, _
    ByVal cStores As Long, _
    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

PSCreateDelayedMultiplexPropertyStore = ctypes.windll.propsys.PSCreateDelayedMultiplexPropertyStore
PSCreateDelayedMultiplexPropertyStore.restype = ctypes.c_int
PSCreateDelayedMultiplexPropertyStore.argtypes = [
    ctypes.c_int,  # flags : GETPROPERTYSTOREFLAGS
    ctypes.c_void_p,  # pdpsf : IDelayedPropertyStoreFactory*
    ctypes.POINTER(wintypes.DWORD),  # rgStoreIds : DWORD*
    wintypes.DWORD,  # cStores : DWORD
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
PSCreateDelayedMultiplexPropertyStore = Fiddle::Function.new(
  lib['PSCreateDelayedMultiplexPropertyStore'],
  [
    Fiddle::TYPE_INT,  # flags : GETPROPERTYSTOREFLAGS
    Fiddle::TYPE_VOIDP,  # pdpsf : IDelayedPropertyStoreFactory*
    Fiddle::TYPE_VOIDP,  # rgStoreIds : DWORD*
    -Fiddle::TYPE_INT,  # cStores : DWORD
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "propsys")]
extern "system" {
    fn PSCreateDelayedMultiplexPropertyStore(
        flags: i32,  // GETPROPERTYSTOREFLAGS
        pdpsf: *mut core::ffi::c_void,  // IDelayedPropertyStoreFactory*
        rgStoreIds: *const u32,  // DWORD*
        cStores: u32,  // DWORD
        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 PSCreateDelayedMultiplexPropertyStore(int flags, IntPtr pdpsf, ref uint rgStoreIds, uint cStores, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PROPSYS_PSCreateDelayedMultiplexPropertyStore' -Namespace Win32 -PassThru
# $api::PSCreateDelayedMultiplexPropertyStore(flags, pdpsf, rgStoreIds, cStores, riid, ppv)

#uselib "PROPSYS.dll"
#func global PSCreateDelayedMultiplexPropertyStore "PSCreateDelayedMultiplexPropertyStore" sptr, sptr, sptr, sptr, sptr, sptr
; PSCreateDelayedMultiplexPropertyStore flags, pdpsf, varptr(rgStoreIds), cStores, varptr(riid), ppv   ; 戻り値は stat
; flags : GETPROPERTYSTOREFLAGS -> "sptr"
; pdpsf : IDelayedPropertyStoreFactory* -> "sptr"
; rgStoreIds : DWORD* -> "sptr"
; cStores : DWORD -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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