Win32 API 日本語リファレンス
ホームUI.Shell › SHReplaceFromPropSheetExtArray

SHReplaceFromPropSheetExtArray

関数
拡張配列でプロパティシートページを置き換える。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD SHReplaceFromPropSheetExtArray(
    HPSXA hpsxa,
    DWORD uPageID,
    LPFNSVADDPROPSHEETPAGE lpfnReplaceWith,
    LPARAM lParam
);

パラメーター

名前方向説明
hpsxaHPSXAinSHCreatePropSheetExtArray の呼び出しによって返されたプロパティシート配列ハンドル (HPSXA)。
uPageIDDWORDin置き換えるページの ID。
lpfnReplaceWithLPFNSVADDPROPSHEETPAGEinプロパティシート拡張がプロパティシートにページを追加するために使用する AddPropSheetPageProc 関数へのポインター。
lParamLPARAMinアプリケーション定義の値。

戻り値の型: DWORD

公式ドキュメント

プロパティシート拡張配列内の各プロパティシートに対して、ページの置き換えを要求します。各ページは最大1回まで置き換えることができます。

戻り値

型: UINT

実際に実行された置き換えの回数。

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

各言語での呼び出し定義

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

DWORD SHReplaceFromPropSheetExtArray(
    HPSXA hpsxa,
    DWORD uPageID,
    LPFNSVADDPROPSHEETPAGE lpfnReplaceWith,
    LPARAM lParam
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern uint SHReplaceFromPropSheetExtArray(
    IntPtr hpsxa,   // HPSXA
    uint uPageID,   // DWORD
    IntPtr lpfnReplaceWith,   // LPFNSVADDPROPSHEETPAGE
    IntPtr lParam   // LPARAM
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHReplaceFromPropSheetExtArray(
    hpsxa As IntPtr,   ' HPSXA
    uPageID As UInteger,   ' DWORD
    lpfnReplaceWith As IntPtr,   ' LPFNSVADDPROPSHEETPAGE
    lParam As IntPtr   ' LPARAM
) As UInteger
End Function
' hpsxa : HPSXA
' uPageID : DWORD
' lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE
' lParam : LPARAM
Declare PtrSafe Function SHReplaceFromPropSheetExtArray Lib "shell32" ( _
    ByVal hpsxa As LongPtr, _
    ByVal uPageID As Long, _
    ByVal lpfnReplaceWith As LongPtr, _
    ByVal lParam As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHReplaceFromPropSheetExtArray = ctypes.windll.shell32.SHReplaceFromPropSheetExtArray
SHReplaceFromPropSheetExtArray.restype = wintypes.DWORD
SHReplaceFromPropSheetExtArray.argtypes = [
    wintypes.HANDLE,  # hpsxa : HPSXA
    wintypes.DWORD,  # uPageID : DWORD
    ctypes.c_void_p,  # lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE
    ctypes.c_ssize_t,  # lParam : LPARAM
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHReplaceFromPropSheetExtArray = Fiddle::Function.new(
  lib['SHReplaceFromPropSheetExtArray'],
  [
    Fiddle::TYPE_VOIDP,  # hpsxa : HPSXA
    -Fiddle::TYPE_INT,  # uPageID : DWORD
    Fiddle::TYPE_VOIDP,  # lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
  ],
  -Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHReplaceFromPropSheetExtArray(
        hpsxa: *mut core::ffi::c_void,  // HPSXA
        uPageID: u32,  // DWORD
        lpfnReplaceWith: *const core::ffi::c_void,  // LPFNSVADDPROPSHEETPAGE
        lParam: isize  // LPARAM
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern uint SHReplaceFromPropSheetExtArray(IntPtr hpsxa, uint uPageID, IntPtr lpfnReplaceWith, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHReplaceFromPropSheetExtArray' -Namespace Win32 -PassThru
# $api::SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam)
#uselib "SHELL32.dll"
#func global SHReplaceFromPropSheetExtArray "SHReplaceFromPropSheetExtArray" sptr, sptr, sptr, sptr
; SHReplaceFromPropSheetExtArray hpsxa, uPageID, lpfnReplaceWith, lParam   ; 戻り値は stat
; hpsxa : HPSXA -> "sptr"
; uPageID : DWORD -> "sptr"
; lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> "sptr"
; lParam : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global SHReplaceFromPropSheetExtArray "SHReplaceFromPropSheetExtArray" sptr, int, sptr, sptr
; res = SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam)
; hpsxa : HPSXA -> "sptr"
; uPageID : DWORD -> "int"
; lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> "sptr"
; lParam : LPARAM -> "sptr"
; DWORD SHReplaceFromPropSheetExtArray(HPSXA hpsxa, DWORD uPageID, LPFNSVADDPROPSHEETPAGE lpfnReplaceWith, LPARAM lParam)
#uselib "SHELL32.dll"
#cfunc global SHReplaceFromPropSheetExtArray "SHReplaceFromPropSheetExtArray" intptr, int, intptr, intptr
; res = SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam)
; hpsxa : HPSXA -> "intptr"
; uPageID : DWORD -> "int"
; lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> "intptr"
; lParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHReplaceFromPropSheetExtArray = shell32.NewProc("SHReplaceFromPropSheetExtArray")
)

// hpsxa (HPSXA), uPageID (DWORD), lpfnReplaceWith (LPFNSVADDPROPSHEETPAGE), lParam (LPARAM)
r1, _, err := procSHReplaceFromPropSheetExtArray.Call(
	uintptr(hpsxa),
	uintptr(uPageID),
	uintptr(lpfnReplaceWith),
	uintptr(lParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SHReplaceFromPropSheetExtArray(
  hpsxa: THandle;   // HPSXA
  uPageID: DWORD;   // DWORD
  lpfnReplaceWith: Pointer;   // LPFNSVADDPROPSHEETPAGE
  lParam: NativeInt   // LPARAM
): DWORD; stdcall;
  external 'SHELL32.dll' name 'SHReplaceFromPropSheetExtArray';
result := DllCall("SHELL32\SHReplaceFromPropSheetExtArray"
    , "Ptr", hpsxa   ; HPSXA
    , "UInt", uPageID   ; DWORD
    , "Ptr", lpfnReplaceWith   ; LPFNSVADDPROPSHEETPAGE
    , "Ptr", lParam   ; LPARAM
    , "UInt")   ; return: DWORD
●SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam) = DLL("SHELL32.dll", "dword SHReplaceFromPropSheetExtArray(void*, dword, void*, int)")
# 呼び出し: SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam)
# hpsxa : HPSXA -> "void*"
# uPageID : DWORD -> "dword"
# lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> "void*"
# lParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHReplaceFromPropSheetExtArray(
    hpsxa: ?*anyopaque, // HPSXA
    uPageID: u32, // DWORD
    lpfnReplaceWith: ?*anyopaque, // LPFNSVADDPROPSHEETPAGE
    lParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) u32;
proc SHReplaceFromPropSheetExtArray(
    hpsxa: pointer,  # HPSXA
    uPageID: uint32,  # DWORD
    lpfnReplaceWith: pointer,  # LPFNSVADDPROPSHEETPAGE
    lParam: int  # LPARAM
): uint32 {.importc: "SHReplaceFromPropSheetExtArray", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
uint SHReplaceFromPropSheetExtArray(
    void* hpsxa,   // HPSXA
    uint uPageID,   // DWORD
    void* lpfnReplaceWith,   // LPFNSVADDPROPSHEETPAGE
    ptrdiff_t lParam   // LPARAM
);
ccall((:SHReplaceFromPropSheetExtArray, "SHELL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}, Int),
      hpsxa, uPageID, lpfnReplaceWith, lParam)
# hpsxa : HPSXA -> Ptr{Cvoid}
# uPageID : DWORD -> UInt32
# lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> Ptr{Cvoid}
# lParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHReplaceFromPropSheetExtArray(
    void* hpsxa,
    uint32_t uPageID,
    void* lpfnReplaceWith,
    intptr_t lParam);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam)
-- hpsxa : HPSXA
-- uPageID : DWORD
-- lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE
-- lParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHReplaceFromPropSheetExtArray = lib.func('__stdcall', 'SHReplaceFromPropSheetExtArray', 'uint32_t', ['void *', 'uint32_t', 'void *', 'intptr_t']);
// SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam)
// hpsxa : HPSXA -> 'void *'
// uPageID : DWORD -> 'uint32_t'
// lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> 'void *'
// lParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("SHELL32.dll", {
  SHReplaceFromPropSheetExtArray: { parameters: ["pointer", "u32", "pointer", "isize"], result: "u32" },
});
// lib.symbols.SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam)
// hpsxa : HPSXA -> "pointer"
// uPageID : DWORD -> "u32"
// lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> "pointer"
// lParam : LPARAM -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHReplaceFromPropSheetExtArray(
    void* hpsxa,
    uint32_t uPageID,
    void* lpfnReplaceWith,
    intptr_t lParam);
C, "SHELL32.dll");
// $ffi->SHReplaceFromPropSheetExtArray(hpsxa, uPageID, lpfnReplaceWith, lParam);
// hpsxa : HPSXA
// uPageID : DWORD
// lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE
// lParam : LPARAM
// 構造体/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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    int SHReplaceFromPropSheetExtArray(
        Pointer hpsxa,   // HPSXA
        int uPageID,   // DWORD
        Callback lpfnReplaceWith,   // LPFNSVADDPROPSHEETPAGE
        long lParam   // LPARAM
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHReplaceFromPropSheetExtArray = SHReplaceFromPropSheetExtArray(
    hpsxa : Void*,   # HPSXA
    uPageID : UInt32,   # DWORD
    lpfnReplaceWith : Void*,   # LPFNSVADDPROPSHEETPAGE
    lParam : LibC::SSizeT   # LPARAM
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHReplaceFromPropSheetExtArrayNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>, IntPtr);
typedef SHReplaceFromPropSheetExtArrayDart = int Function(Pointer<Void>, int, Pointer<Void>, int);
final SHReplaceFromPropSheetExtArray = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHReplaceFromPropSheetExtArrayNative, SHReplaceFromPropSheetExtArrayDart>('SHReplaceFromPropSheetExtArray');
// hpsxa : HPSXA -> Pointer<Void>
// uPageID : DWORD -> Uint32
// lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> Pointer<Void>
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHReplaceFromPropSheetExtArray(
  hpsxa: THandle;   // HPSXA
  uPageID: DWORD;   // DWORD
  lpfnReplaceWith: Pointer;   // LPFNSVADDPROPSHEETPAGE
  lParam: NativeInt   // LPARAM
): DWORD; stdcall;
  external 'SHELL32.dll' name 'SHReplaceFromPropSheetExtArray';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHReplaceFromPropSheetExtArray"
  c_SHReplaceFromPropSheetExtArray :: Ptr () -> Word32 -> Ptr () -> CIntPtr -> IO Word32
-- hpsxa : HPSXA -> Ptr ()
-- uPageID : DWORD -> Word32
-- lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> Ptr ()
-- lParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shreplacefrompropsheetextarray =
  foreign "SHReplaceFromPropSheetExtArray"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> intptr_t @-> returning uint32_t)
(* hpsxa : HPSXA -> (ptr void) *)
(* uPageID : DWORD -> uint32_t *)
(* lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> (ptr void) *)
(* lParam : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHReplaceFromPropSheetExtArray" shreplace-from-prop-sheet-ext-array :convention :stdcall) :uint32
  (hpsxa :pointer)   ; HPSXA
  (u-page-id :uint32)   ; DWORD
  (lpfn-replace-with :pointer)   ; LPFNSVADDPROPSHEETPAGE
  (l-param :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHReplaceFromPropSheetExtArray = Win32::API::More->new('SHELL32',
    'DWORD SHReplaceFromPropSheetExtArray(HANDLE hpsxa, DWORD uPageID, LPVOID lpfnReplaceWith, LPARAM lParam)');
# my $ret = $SHReplaceFromPropSheetExtArray->Call($hpsxa, $uPageID, $lpfnReplaceWith, $lParam);
# hpsxa : HPSXA -> HANDLE
# uPageID : DWORD -> DWORD
# lpfnReplaceWith : LPFNSVADDPROPSHEETPAGE -> LPVOID
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型