Win32 API 日本語リファレンス
ホーム › Devices.DeviceAndDriverInstallation › SP_PROPSHEETPAGE_REQUEST

SP_PROPSHEETPAGE_REQUEST

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 24 バイト / x86: 16 バイトパッキング1

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
cbSizeDWORD4+0+0SP_PROPSHEETPAGE_REQUEST 構造体のサイズ (バイト単位)。
PageRequestedDWORD4+4+4

プロパティシートに追加するプロパティシートページ。次のいずれかの値を指定できます。

SPPSR_SELECT_DEVICE_RESOURCES

SetupAPI DLL が提供するリソース選択ページを指定します。

SPPSR_ENUM_BASIC_DEVICE_PROPERTIES

デバイスの BasicProperties32 プロバイダーが提供するページを指定します。つまり、DIF_ADDPROPERTYPAGE_BASIC インストール要求に応じてページを提供したインストーラーまたはその他のコンポーネントです。

SPPSR_ENUM_ADV_DEVICE_PROPERTIES

クラス、またはデバイスの EnumPropPages32 プロバイダー (あるいはその両方) が提供するページを指定します。つまり、DIF_ADDPROPERTYPAGE_ADVANCED インストール要求に応じてページを提供したインストーラーまたはその他のコンポーネントです。

DeviceInfoSetHDEVINFO8/4+8+8インストール対象のデバイスを含むデバイス情報セットのハンドルです。
DeviceInfoDataSP_DEVINFO_DATA*8/4+16+12インストール対象のデバイスの SP_DEVINFO_DATA 構造体へのポインターです。

公式ドキュメント

SP_PROPSHEETPAGE_REQUEST 構造体は、SetupAPI DLL の ExtensionPropSheetPageProc エントリポイントに第 1 パラメーター (lpv) として渡すことができます。ExtensionPropSheetPageProc は、指定されたプロパティシートページのハンドルを取得するために使用されます。

ExtensionPropSheetPageProc および関連する関数については、Microsoft Windows SDK のドキュメントを参照してください。

解説(Remarks)

プロパティページを取得するコンポーネントは、SetupAPI の ExtensionPropSheetPageProc 関数を呼び出し、SP_PROPSHEETPAGE_REQUEST 構造体へのポインター、自身の AddPropSheetPageProc 関数のアドレス、およびプライベートデータを渡します。プロパティシートプロバイダーは、提供するプロパティシートごとに AddPropSheetPageProc ルーチンを呼び出します。

次のコード例は、1 つのページ (SetupAPI のリソース選択ページ) を取得する方法を示しています。

{
    DWORD Err;
    HINSTANCE hLib;
    FARPROC PropSheetExtProc;
    HPROPSHEETPAGE hPages[2];
    .
    .
    .
        if(!(hLib = GetModuleHandle(TEXT("setupapi.dll")))) {
            return GetLastError();
        }

        if(!(PropSheetExtProc = GetProcAddress(hLib,
                 "ExtensionPropSheetPageProc"))) {
            Err = GetLastError();
            FreeLibrary(hLib);
            return Err;
        }

        PropPageRequest.cbSize = sizeof(SP_PROPSHEETPAGE_REQUEST);
        PropPageRequest.PageRequested  = 
            SPPSR_SELECT_DEVICE_RESOURCES;
        PropPageRequest.DeviceInfoSet  = DeviceInfoSet;
        PropPageRequest.DeviceInfoData = DeviceInfoData;

        if(!PropSheetExtProc(&PropPageRequest, 
                AddPropSheetPageProc, &hPages[1])) {
            Err = ERROR_INVALID_PARAMETER;
            FreeLibrary(hLib);
            return Err;
        }
        .
        .
        .
}

上記の例における AddPropSheetPageProc は、次のようなものになります。

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

各言語での定義

#include <windows.h>

// SP_PROPSHEETPAGE_REQUEST  (x64 24 / x86 16 バイト)
#pragma pack(push, 1)
typedef struct SP_PROPSHEETPAGE_REQUEST {
    DWORD cbSize;
    DWORD PageRequested;
    HDEVINFO DeviceInfoSet;
    SP_DEVINFO_DATA* DeviceInfoData;
} SP_PROPSHEETPAGE_REQUEST;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct SP_PROPSHEETPAGE_REQUEST
{
    public uint cbSize;
    public uint PageRequested;
    public IntPtr DeviceInfoSet;
    public IntPtr DeviceInfoData;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure SP_PROPSHEETPAGE_REQUEST
    Public cbSize As UInteger
    Public PageRequested As UInteger
    Public DeviceInfoSet As IntPtr
    Public DeviceInfoData As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class SP_PROPSHEETPAGE_REQUEST(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("PageRequested", wintypes.DWORD),
        ("DeviceInfoSet", ctypes.c_ssize_t),
        ("DeviceInfoData", ctypes.c_void_p),
    ]
#[repr(C, packed(1))]
pub struct SP_PROPSHEETPAGE_REQUEST {
    pub cbSize: u32,
    pub PageRequested: u32,
    pub DeviceInfoSet: isize,
    pub DeviceInfoData: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type SP_PROPSHEETPAGE_REQUEST struct {
	cbSize uint32
	PageRequested uint32
	DeviceInfoSet uintptr
	DeviceInfoData uintptr
}
type
  SP_PROPSHEETPAGE_REQUEST = packed record
    cbSize: DWORD;
    PageRequested: DWORD;
    DeviceInfoSet: NativeInt;
    DeviceInfoData: Pointer;
  end;
const SP_PROPSHEETPAGE_REQUEST = extern struct {
    cbSize: u32,
    PageRequested: u32,
    DeviceInfoSet: isize,
    DeviceInfoData: ?*anyopaque,
};
type
  SP_PROPSHEETPAGE_REQUEST {.packed.} = object
    cbSize: uint32
    PageRequested: uint32
    DeviceInfoSet: int
    DeviceInfoData: pointer
align(1)
struct SP_PROPSHEETPAGE_REQUEST
{
    uint cbSize;
    uint PageRequested;
    ptrdiff_t DeviceInfoSet;
    void* DeviceInfoData;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; SP_PROPSHEETPAGE_REQUEST サイズ: 16 バイト(x86)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; PageRequested : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; DeviceInfoSet : HDEVINFO (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; DeviceInfoData : SP_DEVINFO_DATA* (+12, 4byte)  varptr(st)+12 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SP_PROPSHEETPAGE_REQUEST サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; PageRequested : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; DeviceInfoSet : HDEVINFO (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; DeviceInfoData : SP_DEVINFO_DATA* (+16, 8byte)  varptr(st)+16 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SP_PROPSHEETPAGE_REQUEST, pack=1
    #field int cbSize
    #field int PageRequested
    #field intptr DeviceInfoSet
    #field intptr DeviceInfoData
#endstruct

stdim st, SP_PROPSHEETPAGE_REQUEST        ; NSTRUCT 変数を確保
st->cbSize = 100
mes "cbSize=" + st->cbSize