Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
rgpropkeyPROPERTYKEY*inoptional変更対象プロパティのキー配列。
rgflagsPKA_FLAGS*inoptional各変更の動作を示すPKA_FLAGS配列。
rgpropvarPROPVARIANT*inoptional各プロパティに設定する新しい値のPROPVARIANT配列。
cChangesDWORDin上記各配列の要素数。
riidGUID*in要求するインターフェイスの識別子GUIDへのポインタ。
ppvvoid**out生成したプロパティ変更配列オブジェクトを受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; HRESULT PSCreatePropertyChangeArray(PROPERTYKEY* rgpropkey, PKA_FLAGS* rgflags, PROPVARIANT* rgpropvar, DWORD cChanges, GUID* riid, void** ppv)
#uselib "PROPSYS.dll"
#cfunc global PSCreatePropertyChangeArray "PSCreatePropertyChangeArray" var, var, var, int, var, intptr
; 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 -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	propsys = windows.NewLazySystemDLL("PROPSYS.dll")
	procPSCreatePropertyChangeArray = propsys.NewProc("PSCreatePropertyChangeArray")
)

// rgpropkey (PROPERTYKEY* optional), rgflags (PKA_FLAGS* optional), rgpropvar (PROPVARIANT* optional), cChanges (DWORD), riid (GUID*), ppv (void** out)
r1, _, err := procPSCreatePropertyChangeArray.Call(
	uintptr(rgpropkey),
	uintptr(rgflags),
	uintptr(rgpropvar),
	uintptr(cChanges),
	uintptr(riid),
	uintptr(ppv),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function PSCreatePropertyChangeArray(
  rgpropkey: Pointer;   // PROPERTYKEY* optional
  rgflags: Pointer;   // PKA_FLAGS* optional
  rgpropvar: Pointer;   // PROPVARIANT* optional
  cChanges: DWORD;   // DWORD
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PSCreatePropertyChangeArray';
result := DllCall("PROPSYS\PSCreatePropertyChangeArray"
    , "Ptr", rgpropkey   ; PROPERTYKEY* optional
    , "Ptr", rgflags   ; PKA_FLAGS* optional
    , "Ptr", rgpropvar   ; PROPVARIANT* optional
    , "UInt", cChanges   ; DWORD
    , "Ptr", riid   ; GUID*
    , "Ptr", ppv   ; void** out
    , "Int")   ; return: HRESULT
●PSCreatePropertyChangeArray(rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv) = DLL("PROPSYS.dll", "int PSCreatePropertyChangeArray(void*, void*, void*, dword, void*, void*)")
# 呼び出し: PSCreatePropertyChangeArray(rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv)
# rgpropkey : PROPERTYKEY* optional -> "void*"
# rgflags : PKA_FLAGS* optional -> "void*"
# rgpropvar : PROPVARIANT* optional -> "void*"
# cChanges : DWORD -> "dword"
# riid : GUID* -> "void*"
# ppv : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "propsys" fn PSCreatePropertyChangeArray(
    rgpropkey: [*c]PROPERTYKEY, // PROPERTYKEY* optional
    rgflags: [*c]i32, // PKA_FLAGS* optional
    rgpropvar: [*c]PROPVARIANT, // PROPVARIANT* optional
    cChanges: u32, // DWORD
    riid: [*c]GUID, // GUID*
    ppv: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;
proc PSCreatePropertyChangeArray(
    rgpropkey: ptr PROPERTYKEY,  # PROPERTYKEY* optional
    rgflags: ptr int32,  # PKA_FLAGS* optional
    rgpropvar: ptr PROPVARIANT,  # PROPVARIANT* optional
    cChanges: uint32,  # DWORD
    riid: ptr GUID,  # GUID*
    ppv: pointer  # void** out
): int32 {.importc: "PSCreatePropertyChangeArray", stdcall, dynlib: "PROPSYS.dll".}
pragma(lib, "propsys");
extern(Windows)
int PSCreatePropertyChangeArray(
    PROPERTYKEY* rgpropkey,   // PROPERTYKEY* optional
    int* rgflags,   // PKA_FLAGS* optional
    PROPVARIANT* rgpropvar,   // PROPVARIANT* optional
    uint cChanges,   // DWORD
    GUID* riid,   // GUID*
    void** ppv   // void** out
);
ccall((:PSCreatePropertyChangeArray, "PROPSYS.dll"), stdcall, Int32,
      (Ptr{PROPERTYKEY}, Ptr{Int32}, Ptr{PROPVARIANT}, UInt32, Ptr{GUID}, Ptr{Cvoid}),
      rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv)
# rgpropkey : PROPERTYKEY* optional -> Ptr{PROPERTYKEY}
# rgflags : PKA_FLAGS* optional -> Ptr{Int32}
# rgpropvar : PROPVARIANT* optional -> Ptr{PROPVARIANT}
# cChanges : DWORD -> UInt32
# riid : GUID* -> Ptr{GUID}
# ppv : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t PSCreatePropertyChangeArray(
    void* rgpropkey,
    int32_t* rgflags,
    void* rgpropvar,
    uint32_t cChanges,
    void* riid,
    void** ppv);
]]
local propsys = ffi.load("propsys")
-- propsys.PSCreatePropertyChangeArray(rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv)
-- rgpropkey : PROPERTYKEY* optional
-- rgflags : PKA_FLAGS* optional
-- rgpropvar : PROPVARIANT* optional
-- cChanges : DWORD
-- riid : GUID*
-- ppv : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('PROPSYS.dll');
const PSCreatePropertyChangeArray = lib.func('__stdcall', 'PSCreatePropertyChangeArray', 'int32_t', ['void *', 'int32_t *', 'void *', 'uint32_t', 'void *', 'void *']);
// PSCreatePropertyChangeArray(rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv)
// rgpropkey : PROPERTYKEY* optional -> 'void *'
// rgflags : PKA_FLAGS* optional -> 'int32_t *'
// rgpropvar : PROPVARIANT* optional -> 'void *'
// cChanges : DWORD -> 'uint32_t'
// riid : GUID* -> 'void *'
// ppv : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("PROPSYS.dll", {
  PSCreatePropertyChangeArray: { parameters: ["pointer", "pointer", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.PSCreatePropertyChangeArray(rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv)
// rgpropkey : PROPERTYKEY* optional -> "pointer"
// rgflags : PKA_FLAGS* optional -> "pointer"
// rgpropvar : PROPVARIANT* optional -> "pointer"
// cChanges : DWORD -> "u32"
// riid : GUID* -> "pointer"
// ppv : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PSCreatePropertyChangeArray(
    void* rgpropkey,
    int32_t* rgflags,
    void* rgpropvar,
    uint32_t cChanges,
    void* riid,
    void** ppv);
C, "PROPSYS.dll");
// $ffi->PSCreatePropertyChangeArray(rgpropkey, rgflags, rgpropvar, cChanges, riid, ppv);
// rgpropkey : PROPERTYKEY* optional
// rgflags : PKA_FLAGS* optional
// rgpropvar : PROPVARIANT* optional
// cChanges : DWORD
// riid : GUID*
// ppv : void** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Propsys extends StdCallLibrary {
    Propsys INSTANCE = Native.load("propsys", Propsys.class);
    int PSCreatePropertyChangeArray(
        Pointer rgpropkey,   // PROPERTYKEY* optional
        IntByReference rgflags,   // PKA_FLAGS* optional
        Pointer rgpropvar,   // PROPVARIANT* optional
        int cChanges,   // DWORD
        Pointer riid,   // GUID*
        Pointer ppv   // void** out
    );
}
@[Link("propsys")]
lib LibPROPSYS
  fun PSCreatePropertyChangeArray = PSCreatePropertyChangeArray(
    rgpropkey : PROPERTYKEY*,   # PROPERTYKEY* optional
    rgflags : Int32*,   # PKA_FLAGS* optional
    rgpropvar : PROPVARIANT*,   # PROPVARIANT* optional
    cChanges : UInt32,   # DWORD
    riid : GUID*,   # GUID*
    ppv : Void**   # void** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PSCreatePropertyChangeArrayNative = Int32 Function(Pointer<Void>, Pointer<Int32>, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef PSCreatePropertyChangeArrayDart = int Function(Pointer<Void>, Pointer<Int32>, Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final PSCreatePropertyChangeArray = DynamicLibrary.open('PROPSYS.dll')
    .lookupFunction<PSCreatePropertyChangeArrayNative, PSCreatePropertyChangeArrayDart>('PSCreatePropertyChangeArray');
// rgpropkey : PROPERTYKEY* optional -> Pointer<Void>
// rgflags : PKA_FLAGS* optional -> Pointer<Int32>
// rgpropvar : PROPVARIANT* optional -> Pointer<Void>
// cChanges : DWORD -> Uint32
// riid : GUID* -> Pointer<Void>
// ppv : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PSCreatePropertyChangeArray(
  rgpropkey: Pointer;   // PROPERTYKEY* optional
  rgflags: Pointer;   // PKA_FLAGS* optional
  rgpropvar: Pointer;   // PROPVARIANT* optional
  cChanges: DWORD;   // DWORD
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'PROPSYS.dll' name 'PSCreatePropertyChangeArray';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PSCreatePropertyChangeArray"
  c_PSCreatePropertyChangeArray :: Ptr () -> Ptr Int32 -> Ptr () -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- rgpropkey : PROPERTYKEY* optional -> Ptr ()
-- rgflags : PKA_FLAGS* optional -> Ptr Int32
-- rgpropvar : PROPVARIANT* optional -> Ptr ()
-- cChanges : DWORD -> Word32
-- riid : GUID* -> Ptr ()
-- ppv : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pscreatepropertychangearray =
  foreign "PSCreatePropertyChangeArray"
    ((ptr void) @-> (ptr int32_t) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* rgpropkey : PROPERTYKEY* optional -> (ptr void) *)
(* rgflags : PKA_FLAGS* optional -> (ptr int32_t) *)
(* rgpropvar : PROPVARIANT* optional -> (ptr void) *)
(* cChanges : DWORD -> uint32_t *)
(* riid : GUID* -> (ptr void) *)
(* ppv : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library propsys (t "PROPSYS.dll"))
(cffi:use-foreign-library propsys)

(cffi:defcfun ("PSCreatePropertyChangeArray" pscreate-property-change-array :convention :stdcall) :int32
  (rgpropkey :pointer)   ; PROPERTYKEY* optional
  (rgflags :pointer)   ; PKA_FLAGS* optional
  (rgpropvar :pointer)   ; PROPVARIANT* optional
  (c-changes :uint32)   ; DWORD
  (riid :pointer)   ; GUID*
  (ppv :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PSCreatePropertyChangeArray = Win32::API::More->new('PROPSYS',
    'int PSCreatePropertyChangeArray(LPVOID rgpropkey, LPVOID rgflags, LPVOID rgpropvar, DWORD cChanges, LPVOID riid, LPVOID ppv)');
# my $ret = $PSCreatePropertyChangeArray->Call($rgpropkey, $rgflags, $rgpropvar, $cChanges, $riid, $ppv);
# rgpropkey : PROPERTYKEY* optional -> LPVOID
# rgflags : PKA_FLAGS* optional -> LPVOID
# rgpropvar : PROPVARIANT* optional -> LPVOID
# cChanges : DWORD -> DWORD
# riid : GUID* -> LPVOID
# ppv : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型