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

SHAddFromPropSheetExtArray

関数
拡張配列からプロパティシートページを追加する。
DLLSHELL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SHAddFromPropSheetExtArray(
    HPSXA hpsxa,
    LPFNSVADDPROPSHEETPAGE lpfnAddPage,
    LPARAM lParam
);

パラメーター

名前方向説明
hpsxaHPSXAinSHCreatePropSheetExtArray によって返されたプロパティシートハンドラーの配列です。
lpfnAddPageLPFNSVADDPROPSHEETPAGEinAddPropSheetPageProc コールバック関数へのポインターです。この関数は各プロパティシートハンドラーに対して1回ずつ呼び出されます。コールバック関数は、そのハンドラーのプロパティシートにページを追加するために必要な情報を返します。
lParamLPARAMinアプリケーション定義のデータへのポインターです。このデータは lpfnAddPage で指定されたコールバック関数に渡されます。

戻り値の型: DWORD

公式ドキュメント

SHCreatePropSheetExtArray によって作成されたプロパティシート拡張配列にページを追加します。

戻り値

型: UINT

実際に追加されたページ数を返します。

解説(Remarks)

この関数は、hpsxa で指定されたプロパティシート拡張配列に対して1回だけ呼び出してください。

この関数は各拡張の IShellPropSheetExt::AddPages メソッドを呼び出します。詳細についてはそのページを参照してください。

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

各言語での呼び出し定義

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

DWORD SHAddFromPropSheetExtArray(
    HPSXA hpsxa,
    LPFNSVADDPROPSHEETPAGE lpfnAddPage,
    LPARAM lParam
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern uint SHAddFromPropSheetExtArray(
    IntPtr hpsxa,   // HPSXA
    IntPtr lpfnAddPage,   // LPFNSVADDPROPSHEETPAGE
    IntPtr lParam   // LPARAM
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHAddFromPropSheetExtArray(
    hpsxa As IntPtr,   ' HPSXA
    lpfnAddPage As IntPtr,   ' LPFNSVADDPROPSHEETPAGE
    lParam As IntPtr   ' LPARAM
) As UInteger
End Function
' hpsxa : HPSXA
' lpfnAddPage : LPFNSVADDPROPSHEETPAGE
' lParam : LPARAM
Declare PtrSafe Function SHAddFromPropSheetExtArray Lib "shell32" ( _
    ByVal hpsxa As LongPtr, _
    ByVal lpfnAddPage 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

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

lib = Fiddle.dlopen('SHELL32.dll')
SHAddFromPropSheetExtArray = Fiddle::Function.new(
  lib['SHAddFromPropSheetExtArray'],
  [
    Fiddle::TYPE_VOIDP,  # hpsxa : HPSXA
    Fiddle::TYPE_VOIDP,  # lpfnAddPage : LPFNSVADDPROPSHEETPAGE
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
  ],
  -Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHAddFromPropSheetExtArray(
        hpsxa: *mut core::ffi::c_void,  // HPSXA
        lpfnAddPage: *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 SHAddFromPropSheetExtArray(IntPtr hpsxa, IntPtr lpfnAddPage, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHAddFromPropSheetExtArray' -Namespace Win32 -PassThru
# $api::SHAddFromPropSheetExtArray(hpsxa, lpfnAddPage, lParam)
#uselib "SHELL32.dll"
#func global SHAddFromPropSheetExtArray "SHAddFromPropSheetExtArray" sptr, sptr, sptr
; SHAddFromPropSheetExtArray hpsxa, lpfnAddPage, lParam   ; 戻り値は stat
; hpsxa : HPSXA -> "sptr"
; lpfnAddPage : LPFNSVADDPROPSHEETPAGE -> "sptr"
; lParam : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global SHAddFromPropSheetExtArray "SHAddFromPropSheetExtArray" sptr, sptr, sptr
; res = SHAddFromPropSheetExtArray(hpsxa, lpfnAddPage, lParam)
; hpsxa : HPSXA -> "sptr"
; lpfnAddPage : LPFNSVADDPROPSHEETPAGE -> "sptr"
; lParam : LPARAM -> "sptr"
; DWORD SHAddFromPropSheetExtArray(HPSXA hpsxa, LPFNSVADDPROPSHEETPAGE lpfnAddPage, LPARAM lParam)
#uselib "SHELL32.dll"
#cfunc global SHAddFromPropSheetExtArray "SHAddFromPropSheetExtArray" intptr, intptr, intptr
; res = SHAddFromPropSheetExtArray(hpsxa, lpfnAddPage, lParam)
; hpsxa : HPSXA -> "intptr"
; lpfnAddPage : LPFNSVADDPROPSHEETPAGE -> "intptr"
; lParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHAddFromPropSheetExtArray = shell32.NewProc("SHAddFromPropSheetExtArray")
)

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

extern "shell32" fn SHAddFromPropSheetExtArray(
    hpsxa: ?*anyopaque, // HPSXA
    lpfnAddPage: ?*anyopaque, // LPFNSVADDPROPSHEETPAGE
    lParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) u32;
proc SHAddFromPropSheetExtArray(
    hpsxa: pointer,  # HPSXA
    lpfnAddPage: pointer,  # LPFNSVADDPROPSHEETPAGE
    lParam: int  # LPARAM
): uint32 {.importc: "SHAddFromPropSheetExtArray", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
uint SHAddFromPropSheetExtArray(
    void* hpsxa,   // HPSXA
    void* lpfnAddPage,   // LPFNSVADDPROPSHEETPAGE
    ptrdiff_t lParam   // LPARAM
);
ccall((:SHAddFromPropSheetExtArray, "SHELL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Int),
      hpsxa, lpfnAddPage, lParam)
# hpsxa : HPSXA -> Ptr{Cvoid}
# lpfnAddPage : LPFNSVADDPROPSHEETPAGE -> Ptr{Cvoid}
# lParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SHAddFromPropSheetExtArray(
    void* hpsxa,
    void* lpfnAddPage,
    intptr_t lParam);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHAddFromPropSheetExtArray(hpsxa, lpfnAddPage, lParam)
-- hpsxa : HPSXA
-- lpfnAddPage : LPFNSVADDPROPSHEETPAGE
-- lParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHAddFromPropSheetExtArray = lib.func('__stdcall', 'SHAddFromPropSheetExtArray', 'uint32_t', ['void *', 'void *', 'intptr_t']);
// SHAddFromPropSheetExtArray(hpsxa, lpfnAddPage, lParam)
// hpsxa : HPSXA -> 'void *'
// lpfnAddPage : LPFNSVADDPROPSHEETPAGE -> 'void *'
// lParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("SHELL32.dll", {
  SHAddFromPropSheetExtArray: { parameters: ["pointer", "pointer", "isize"], result: "u32" },
});
// lib.symbols.SHAddFromPropSheetExtArray(hpsxa, lpfnAddPage, lParam)
// hpsxa : HPSXA -> "pointer"
// lpfnAddPage : LPFNSVADDPROPSHEETPAGE -> "pointer"
// lParam : LPARAM -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SHAddFromPropSheetExtArray(
    void* hpsxa,
    void* lpfnAddPage,
    intptr_t lParam);
C, "SHELL32.dll");
// $ffi->SHAddFromPropSheetExtArray(hpsxa, lpfnAddPage, lParam);
// hpsxa : HPSXA
// lpfnAddPage : 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 SHAddFromPropSheetExtArray(
        Pointer hpsxa,   // HPSXA
        Callback lpfnAddPage,   // LPFNSVADDPROPSHEETPAGE
        long lParam   // LPARAM
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHAddFromPropSheetExtArray = SHAddFromPropSheetExtArray(
    hpsxa : Void*,   # HPSXA
    lpfnAddPage : 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 SHAddFromPropSheetExtArrayNative = Uint32 Function(Pointer<Void>, Pointer<Void>, IntPtr);
typedef SHAddFromPropSheetExtArrayDart = int Function(Pointer<Void>, Pointer<Void>, int);
final SHAddFromPropSheetExtArray = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHAddFromPropSheetExtArrayNative, SHAddFromPropSheetExtArrayDart>('SHAddFromPropSheetExtArray');
// hpsxa : HPSXA -> Pointer<Void>
// lpfnAddPage : LPFNSVADDPROPSHEETPAGE -> Pointer<Void>
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHAddFromPropSheetExtArray(
  hpsxa: THandle;   // HPSXA
  lpfnAddPage: Pointer;   // LPFNSVADDPROPSHEETPAGE
  lParam: NativeInt   // LPARAM
): DWORD; stdcall;
  external 'SHELL32.dll' name 'SHAddFromPropSheetExtArray';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shaddfrompropsheetextarray =
  foreign "SHAddFromPropSheetExtArray"
    ((ptr void) @-> (ptr void) @-> intptr_t @-> returning uint32_t)
(* hpsxa : HPSXA -> (ptr void) *)
(* lpfnAddPage : 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 ("SHAddFromPropSheetExtArray" shadd-from-prop-sheet-ext-array :convention :stdcall) :uint32
  (hpsxa :pointer)   ; HPSXA
  (lpfn-add-page :pointer)   ; LPFNSVADDPROPSHEETPAGE
  (l-param :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHAddFromPropSheetExtArray = Win32::API::More->new('SHELL32',
    'DWORD SHAddFromPropSheetExtArray(HANDLE hpsxa, LPVOID lpfnAddPage, LPARAM lParam)');
# my $ret = $SHAddFromPropSheetExtArray->Call($hpsxa, $lpfnAddPage, $lParam);
# hpsxa : HPSXA -> HANDLE
# lpfnAddPage : LPFNSVADDPROPSHEETPAGE -> LPVOID
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

公式の関連項目
使用する型