ホーム › UI.Shell.PropertiesSystem › PSCreatePropertyChangeArray

PSCreatePropertyChangeArray

関数

複数プロパティ変更を表す変更配列を生成する。

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

シグネチャ

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

HRESULT PSCreatePropertyChangeArray(
    const PROPERTYKEY* rgpropkey,   // optional
    const PKA_FLAGS* rgflags,   // optional
    const PROPVARIANT* rgpropvar,   // optional
    DWORD cChanges,
    const GUID* riid,
    void** ppv
);

パラメーター

名前	型	方向	説明
rgpropkey	PROPERTYKEY*	inoptional	変更を格納する対象のプロパティを指定する PROPERTYKEY 構造体の配列へのポインター。この値が NULL の場合、cChanges は 0 でなければなりません。
rgflags	PKA_FLAGS*	inoptional	PKA_FLAGS 値の配列へのポインター。この値が NULL の場合、cChanges は 0 でなければなりません。
rgpropvar	PROPVARIANT*	inoptional	PROPVARIANT 構造体の配列へのポインター。この値が NULL の場合、cChanges は 0 でなければなりません。
cChanges	DWORD	in	適用する変更の数。これは rgpropkey、rgflags、rgpropvar の各配列の要素数です。
riid	GUID*	in	要求するインターフェイスの ID への参照。
ppv	void**	out	この関数から制御が戻るとき、riid で要求されたインターフェイスポインターが格納されます。通常は IPropertyChangeArray です。

戻り値の型: HRESULT

公式ドキュメント

IPropertyChange オブジェクトのセットを保持するコンテナーを作成します。このコンテナーは IFileOperation と組み合わせて使用し、一連のプロパティ変更を一連のファイルに適用できます。

戻り値

型: HRESULT

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

解説(Remarks)

この関数は、IPropertyChangeArray を実装するコンポーネントオブジェクトモデル (COM) オブジェクトを作成します。このオブジェクトは IPropertyChange インターフェイスのセットを保持するコンテナーであり、IFileOperation と組み合わせて使用し、一連のプロパティ変更を一連のファイルに適用できます。

PSCreatePropertyChangeArray を呼び出す前に、CoInitialize または OleInitialize で COM を初期化しておく必要があります。COM はこのオブジェクトの有効期間中、初期化されたままでなければなりません。プロパティ変更配列はシングルスレッドアパートメント (STA) で実行されます。

プロパティ変更配列は、パラメーターで単純な変更を指定して初期化するか、IPropertyChangeArray の各種メソッドを使用して変更を挿入または追加することで初期化できます。

各パラメーターはインデックス値によって関連付けられます。たとえば、プロパティ rgpropkey[0] に対して、新しい値 rgpropvar[0] が rgflags[0] で指定されたとおりに適用されます。cChanges パラメーターは、このような組み合わせがいくつあるかを示します。したがって、各配列の要素数は同じである必要があります。すなわち ARRAYSIZE(rgpropkey) = ARRAYSIZE(rgflags) = ARRAYSIZE(rgpropvar) = cChanges となります。

IFileOperation は、ファイルを複数回開かずに済むよう、プロパティ変更配列内のすべての変更をファイルに対して同時に適用します。

例

次の例は、より大きなプログラムの一部として使用するものであり、PSCreatePropertyChangeArray を使用して、1 つ以上のファイルの Comment プロパティを "Fun" に、Rating を 4 に設定する方法を示します。

// IFileOperation *pfo;
// 変数 pfo は、SetOperationFlags、ApplyPropertiesToItems、SetProgressMessage を
// 適宜呼び出して初期化済みであるものとします。
 
PROPVARIANT rgpropvar[2] = {0};

HRESULT hr = InitPropVariantFromString(L"Fun", &rgpropvar[0]);

if (SUCCEEDED(hr))
{
    hr = InitPropVariantFromUInt32(RATING_FOUR_STARS_SET, &rgpropvar[1]);

    if (SUCCEEDED(hr))
    {
        REFPROPERTYKEY rgkey[2] = {PKEY_Comment, PKEY_Rating};
        PKA_FLAGS rgflags[2] = {PKA_SET, PKA_SET};
        IPropertyChangeArray *pChangeArray;

        hr = PSCreatePropertyChangeArray(rgkey, rgflags, rgpropvar, 2, IID_PPV_ARGS(&pChangeArray));

        if (SUCCEEDED(hr))
        {
            hr = pfo->SetProperties(pChangeArray);

            if (SUCCEEDED(hr))
            {
                hr = pfo->PerformOperations();
            }
            pChangeArray->Release();
        }
    }
    ClearPropVariantArray(rgpropvar, ARRAYSIZE(rgpropvar));
}

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

各言語での呼び出し定義

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

HRESULT PSCreatePropertyChangeArray(
    const PROPERTYKEY* rgpropkey,   // optional
    const PKA_FLAGS* rgflags,   // optional
    const PROPVARIANT* rgpropvar,   // optional
    DWORD cChanges,
    const GUID* riid,
    void** ppv
);

[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PSCreatePropertyChangeArray(
    IntPtr rgpropkey,   // PROPERTYKEY* optional
    IntPtr rgflags,   // PKA_FLAGS* optional
    IntPtr rgpropvar,   // PROPVARIANT* optional
    uint cChanges,   // DWORD
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);

<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PSCreatePropertyChangeArray(
    rgpropkey As IntPtr,   ' PROPERTYKEY* optional
    rgflags As IntPtr,   ' PKA_FLAGS* optional
    rgpropvar As IntPtr,   ' PROPVARIANT* optional
    cChanges As UInteger,   ' DWORD
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function

' rgpropkey : PROPERTYKEY* optional
' rgflags : PKA_FLAGS* optional
' rgpropvar : PROPVARIANT* optional
' cChanges : DWORD
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function PSCreatePropertyChangeArray Lib "propsys" ( _
    ByVal rgpropkey As LongPtr, _
    ByVal rgflags As LongPtr, _
    ByVal rgpropvar As LongPtr, _
    ByVal cChanges 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

PSCreatePropertyChangeArray = ctypes.windll.propsys.PSCreatePropertyChangeArray
PSCreatePropertyChangeArray.restype = ctypes.c_int
PSCreatePropertyChangeArray.argtypes = [
    ctypes.c_void_p,  # rgpropkey : PROPERTYKEY* optional
    ctypes.c_void_p,  # rgflags : PKA_FLAGS* optional
    ctypes.c_void_p,  # rgpropvar : PROPVARIANT* optional
    wintypes.DWORD,  # cChanges : DWORD
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
PSCreatePropertyChangeArray = Fiddle::Function.new(
  lib['PSCreatePropertyChangeArray'],
  [
    Fiddle::TYPE_VOIDP,  # rgpropkey : PROPERTYKEY* optional
    Fiddle::TYPE_VOIDP,  # rgflags : PKA_FLAGS* optional
    Fiddle::TYPE_VOIDP,  # rgpropvar : PROPVARIANT* optional
    -Fiddle::TYPE_INT,  # cChanges : DWORD
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "propsys")]
extern "system" {
    fn PSCreatePropertyChangeArray(
        rgpropkey: *const PROPERTYKEY,  // PROPERTYKEY* optional
        rgflags: *const i32,  // PKA_FLAGS* optional
        rgpropvar: *const PROPVARIANT,  // PROPVARIANT* optional
        cChanges: 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 PSCreatePropertyChangeArray(IntPtr rgpropkey, IntPtr rgflags, IntPtr rgpropvar, uint cChanges, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PROPSYS_PSCreatePropertyChangeArray' -Namespace Win32 -PassThru
# $api::PSCreatePropertyChangeArray(rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv)

#uselib "PROPSYS.dll"
#func global PSCreatePropertyChangeArray "PSCreatePropertyChangeArray" sptr, sptr, sptr, sptr, sptr, sptr
; PSCreatePropertyChangeArray varptr(rgpropkey), varptr(rgflags), varptr(rgpropvar), cChanges, varptr(riid), ppv   ; 戻り値は stat
; rgpropkey : PROPERTYKEY* optional -> "sptr"
; rgflags : PKA_FLAGS* optional -> "sptr"
; rgpropvar : PROPVARIANT* optional -> "sptr"
; cChanges : DWORD -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "PROPSYS.dll"
#cfunc global PSCreatePropertyChangeArray "PSCreatePropertyChangeArray" var, var, var, int, var, sptr
; res = PSCreatePropertyChangeArray(rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv)
; rgpropkey : PROPERTYKEY* optional -> "var"
; rgflags : PKA_FLAGS* optional -> "var"
; rgpropvar : PROPVARIANT* optional -> "var"
; cChanges : DWORD -> "int"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "PROPSYS.dll"
#cfunc global PSCreatePropertyChangeArray "PSCreatePropertyChangeArray" sptr, sptr, sptr, int, sptr, sptr
; res = PSCreatePropertyChangeArray(varptr(rgpropkey), varptr(rgflags), varptr(rgpropvar), cChanges, varptr(riid), ppv)
; rgpropkey : PROPERTYKEY* optional -> "sptr"
; rgflags : PKA_FLAGS* optional -> "sptr"
; rgpropvar : PROPVARIANT* optional -> "sptr"
; cChanges : DWORD -> "int"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。