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

PROPSHEETPAGEW_V2

構造体
サイズx64: 88 バイト / x86: 48 バイト

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

フィールド

フィールドサイズx64x86説明
dwSizeDWORD4+0+0この構造体のサイズをバイト単位で指定する。バージョンを示す。
dwFlagsDWORD4+4+4ページの動作を制御するPSP_系フラグの組み合わせ。
hInstanceHINSTANCE8/4+8+8ダイアログテンプレートやアイコンを含むモジュールのハンドル。
Anonymous1_Anonymous1_e__Union8/4+16+12ダイアログテンプレートを指定する共用体。リソース名またはメモリ内テンプレートを保持する。
Anonymous2_Anonymous2_e__Union8/4+24+16ページのアイコンを指定する共用体。アイコンハンドルまたはリソース識別子を保持する。
pszTitleLPWSTR8/4+32+20PSP_USETITLE指定時にタブに表示するページのタイトル文字列。
pfnDlgProcDLGPROC8/4+40+24ページのダイアログプロシージャへのポインタ。
lParamLPARAM8/4+48+28アプリケーション定義データ。ダイアログプロシージャに渡される。
pfnCallbackLPFNPSPCALLBACKW8/4+56+32ページの作成/破棄時に呼ばれるコールバック関数へのポインタ。
pcRefParentDWORD*8/4+64+36親のプロパティシートの参照カウントへのポインタ。PSP_USEREFPARENT時に使う。
pszHeaderTitleLPWSTR8/4+72+40

バージョン 5.80 以降。ヘッダー領域のタイトルです。Wizard97 スタイルのウィザードでこのメンバーを使用するには、次の操作も行う必要があります。

pszHeaderSubTitleLPWSTR8/4+80+44

バージョン 5.80。ヘッダー領域のサブタイトルです。このメンバーを使用するには、次の操作を行う必要があります。

Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このメンバーは無視されます。

- dwFlags

Type: DWORD

プロパティシートページを作成するときに使用するオプションを示すフラグです。このメンバーには、次の値の組み合わせを指定できます。

意味
PSP_DEFAULT
すべての構造体メンバーに既定の意味を使用します。Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このフラグはサポートされません。
PSP_DLGINDIRECT
pResource メンバーが指すメモリ内のダイアログボックステンプレートからページを作成します。PropertySheet 関数は、メモリ内のテンプレートが書き込み保護されていないことを前提とします。読み取り専用のテンプレートは、一部のバージョンの Windows で例外の原因となります。
PSP_HASHELP
ページがアクティブなときに、プロパティシートの ヘルプ ボタンを有効にします。Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このフラグはサポートされません。
PSP_HIDEHEADER

バージョン 5.80 以降。ページが選択されたときに、ウィザードのプロパティシートがヘッダー領域を非表示にするようにします。ウォーターマークが指定されている場合は、ページの左側に描画されます。このフラグは、開始ページと完了ページには設定し、中間ページでは省略してください。Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このフラグはサポートされません。

PSP_PREMATURE

バージョン 4.71 以降。プロパティシートの作成時にページを作成します。このフラグを指定しない場合、ページは最初に選択されるまで作成されません。Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このフラグはサポートされません。

PSP_RTLREADING
pszTitle が表示される方向を反転します。通常のウィンドウでは、pszTitle を含むすべてのテキストが左から右 (LTR) に表示されます。ヘブライ語やアラビア語のように右から左 (RTL) に読む言語では、ウィンドウをミラー化して、すべてのテキストを RTL で表示できます。PSP_RTLREADING が設定されている場合、pszTitle は通常の親ウィンドウでは RTL、ミラー化された親ウィンドウでは LTR で表示されます。
PSP_USECALLBACK
この構造体で定義されるプロパティシートページを作成または破棄するときに、pfnCallback メンバーで指定された関数を呼び出します。
PSP_USEFUSIONCONTEXT

バージョン 6.0 以降。アクティブ化コンテキストを使用します。アクティブ化コンテキストを使用するには、このフラグを設定し、アクティブ化コンテキストのハンドルを hActCtx に割り当てる必要があります。「解説」を参照してください。

PSP_USEHEADERSUBTITLE

バージョン 5.80 以降。pszHeaderSubTitle メンバーが指す文字列を、Wizard97 ページのヘッダー領域のサブタイトルとして表示します。このフラグを使用するには、関連する PROPSHEETHEADER 構造体の dwFlags メンバーに PSH_WIZARD97 フラグも設定する必要があります。PSP_HIDEHEADER が設定されている場合、PSP_USEHEADERSUBTITLE フラグは無視されます。Aero スタイルのウィザードでは、タイトルはクライアント領域の上部付近に表示されます。

PSP_USEHEADERTITLE

バージョン 5.80 以降。pszHeaderTitle メンバーが指す文字列を、Wizard97 の中間ページのヘッダーのタイトルとして表示します。関連する PROPSHEETHEADER 構造体の dwFlags メンバーに PSH_WIZARD97 フラグも設定する必要があります。PSP_HIDEHEADER が設定されている場合、PSP_USEHEADERTITLE フラグは無視されます。Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このフラグはサポートされません。

PSP_USEHICON
hIcon を、ページのタブに表示する小さいアイコンとして使用します。Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このフラグはサポートされません。
PSP_USEICONID
pszIcon を、読み込んでページのタブに表示する小さいアイコンとして使用するアイコンリソースの名前として使用します。Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このフラグはサポートされません。
PSP_USEREFPARENT
この構造体から作成されたプロパティシートページの有効期間中、pcRefParent メンバーで指定された参照カウントを維持します。
PSP_USETITLE
ダイアログボックステンプレートに格納されているタイトルの代わりに、pszTitle メンバーをプロパティシートダイアログボックスのタイトルとして使用します。Aero スタイルのウィザード (PSH_AEROWIZARD) を使用する場合、このフラグはサポートされません。

- dwSize

Type: DWORD

この構造体のサイズ (バイト単位) です。

- hActCtx

Type: HANDLE

バージョン 6.0 以降。アクティブ化コンテキストのハンドルです。CreateActCtx でアクティブ化コンテキストを作成したときに返されるハンドルを、このメンバーに設定します。システムは、ダイアログボックスを作成する前にこのコンテキストをアクティブ化します。グローバルマニフェストを使用する場合、このメンバーを使用する必要はありません。「解説」を参照してください。

- hIcon

Type: HICON

ページのタブ内のアイコンとして使用するアイコンのハンドルです。dwFlags メンバーに PSP_USEHICON が含まれていない場合、このメンバーは無視されます。このメンバーは pszIcon との共用体として宣言されています。

- hInstance

Type: HINSTANCE

アイコンまたは文字列リソースを読み込む元のインスタンスのハンドルです。pszIconpszTitlepszHeaderTitlepszHeaderSubTitle の各メンバーが読み込むリソースを指定している場合は、hInstance を指定する必要があります。

- lParam

Type: LPARAM

ページが作成されると、そのページの PROPSHEETPAGE 構造体のコピーが WM_INITDIALOG メッセージとともにダイアログボックスプロシージャに渡されます。lParam メンバーは、アプリケーション固有の情報をダイアログボックスプロシージャに渡せるように用意されています。ページ自体には影響しません。詳細については、プロパティシートの作成を参照してください。

- pResource

Type: LPCDLGTEMPLATE

メモリ内のダイアログボックステンプレートへのポインターです。PropertySheet 関数は、テンプレートが書き込み保護されていないことを前提とします。読み取り専用のテンプレートは、一部のバージョンの Windows で例外の原因となります。このメンバーを使用するには、dwFlags メンバーに PSP_DLGINDIRECT フラグを設定する必要があります。このメンバーは pszTemplate との共用体として宣言されています。

- pcRefParent

Type: UINT*

参照カウント値へのポインターです。このメンバーを使用するには、dwFlags メンバーに PSP_USEREFPARENT フラグを設定する必要があります。

プロパティシートページが作成されると、pcRefParent が指す値がインクリメントされます。プロパティシートページは、PROPSHEETHEADERdwFlags メンバーに PSH_PROPSHEETPAGE フラグを設定して PropertySheet 関数を呼び出すことで暗黙的に作成されます。CreatePropertySheetPage 関数を使用して明示的に作成することもできます。プロパティシートページが破棄されると、pcRefParent メンバーが指す値がデクリメントされます。これは、プロパティシートが破棄されるときに自動的に行われます。DestroyPropertySheetPage 関数を使用して、プロパティシートページを明示的に破棄することもできます。

- pfnCallback

Type: LPFNPSPCALLBACK

ページが作成されるときと破棄される直前に呼び出される、アプリケーション定義のコールバック関数へのポインターです。コールバック関数の詳細については、PropSheetPageProc を参照してください。このメンバーを使用するには、dwFlags メンバーに PSP_USECALLBACK フラグを設定する必要があります。

- pfnDlgProc

Type: DLGPROC

ページのダイアログボックスプロシージャへのポインターです。ページはモードレスダイアログボックスとして作成されるため、ダイアログボックスプロシージャは EndDialog 関数を呼び出してはなりません。

- pszIcon

Type: LPCSTR

ページのタブ内のアイコンとして使用するアイコンリソースです。このメンバーには、アイコンリソースの識別子、またはアイコンリソースの名前を指定する文字列のアドレスのいずれかを指定できます。このメンバーを使用するには、dwFlags メンバーに PSP_USEICONID フラグを設定する必要があります。このメンバーは hIcon との共用体として宣言されています。

- pszTemplate

Type: LPCSTR

ページの作成に使用するダイアログボックステンプレートです。このメンバーには、テンプレートのリソース識別子、またはテンプレートの名前を指定する文字列のアドレスのいずれかを指定できます。dwFlags メンバーに PSP_DLGINDIRECT フラグが設定されている場合、pszTemplate は無視されます。このメンバーは pResource との共用体として宣言されています。

- pszTitle

Type: LPCSTR

プロパティシートダイアログボックスのタイトルです。このタイトルは、ダイアログボックステンプレートで指定されたタイトルより優先されます。このメンバーには、文字列リソースの識別子、またはタイトルを指定する文字列のアドレスのいずれかを指定できます。このメンバーを使用するには、dwFlags メンバーに PSP_USETITLE フラグを設定する必要があります。

共用体: _Anonymous1_e__Union x64 8B / x86 4B

フィールドサイズx64x86
pszTemplateLPWSTR8/4+0+0
pResourceDLGTEMPLATE*8/4+0+0

共用体: _Anonymous2_e__Union x64 8B / x86 4B

フィールドサイズx64x86
hIconHICON8/4+0+0
pszIconLPWSTR8/4+0+0

公式ドキュメント

プロパティシート内のページを定義します。

メモ

この構造体は、コード内で直接使用することを意図したものではありません。代わりに PROPSHEETPAGE 構造体を使用してください。

解説(Remarks)

Comctl32.dll のバージョン 6 以降は再頒布できません。Comctl32.dll のバージョン 6 以降を使用するには、マニフェストで .dll ファイルを指定します。マニフェストの詳細については、ビジュアルスタイルの有効化を参照してください。

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

各言語での定義

#include <windows.h>

// PROPSHEETPAGEW_V2  (x64 88 / x86 48 バイト)
typedef struct PROPSHEETPAGEW_V2 {
    DWORD dwSize;
    DWORD dwFlags;
    HINSTANCE hInstance;
    _Anonymous1_e__Union Anonymous1;
    _Anonymous2_e__Union Anonymous2;
    LPWSTR pszTitle;
    DLGPROC pfnDlgProc;
    LPARAM lParam;
    LPFNPSPCALLBACKW pfnCallback;
    DWORD* pcRefParent;
    LPWSTR pszHeaderTitle;
    LPWSTR pszHeaderSubTitle;
} PROPSHEETPAGEW_V2;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct PROPSHEETPAGEW_V2
{
    public uint dwSize;
    public uint dwFlags;
    public IntPtr hInstance;
    public _Anonymous1_e__Union Anonymous1;
    public _Anonymous2_e__Union Anonymous2;
    public IntPtr pszTitle;
    public IntPtr pfnDlgProc;
    public IntPtr lParam;
    public IntPtr pfnCallback;
    public IntPtr pcRefParent;
    public IntPtr pszHeaderTitle;
    public IntPtr pszHeaderSubTitle;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure PROPSHEETPAGEW_V2
    Public dwSize As UInteger
    Public dwFlags As UInteger
    Public hInstance As IntPtr
    Public Anonymous1 As _Anonymous1_e__Union
    Public Anonymous2 As _Anonymous2_e__Union
    Public pszTitle As IntPtr
    Public pfnDlgProc As IntPtr
    Public lParam As IntPtr
    Public pfnCallback As IntPtr
    Public pcRefParent As IntPtr
    Public pszHeaderTitle As IntPtr
    Public pszHeaderSubTitle As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class PROPSHEETPAGEW_V2(ctypes.Structure):
    _fields_ = [
        ("dwSize", wintypes.DWORD),
        ("dwFlags", wintypes.DWORD),
        ("hInstance", ctypes.c_void_p),
        ("Anonymous1", _Anonymous1_e__Union),
        ("Anonymous2", _Anonymous2_e__Union),
        ("pszTitle", ctypes.c_void_p),
        ("pfnDlgProc", ctypes.c_void_p),
        ("lParam", ctypes.c_ssize_t),
        ("pfnCallback", ctypes.c_void_p),
        ("pcRefParent", ctypes.c_void_p),
        ("pszHeaderTitle", ctypes.c_void_p),
        ("pszHeaderSubTitle", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct PROPSHEETPAGEW_V2 {
    pub dwSize: u32,
    pub dwFlags: u32,
    pub hInstance: *mut core::ffi::c_void,
    pub Anonymous1: _Anonymous1_e__Union,
    pub Anonymous2: _Anonymous2_e__Union,
    pub pszTitle: *mut core::ffi::c_void,
    pub pfnDlgProc: *mut core::ffi::c_void,
    pub lParam: isize,
    pub pfnCallback: *mut core::ffi::c_void,
    pub pcRefParent: *mut core::ffi::c_void,
    pub pszHeaderTitle: *mut core::ffi::c_void,
    pub pszHeaderSubTitle: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type PROPSHEETPAGEW_V2 struct {
	dwSize uint32
	dwFlags uint32
	hInstance uintptr
	Anonymous1 _Anonymous1_e__Union
	Anonymous2 _Anonymous2_e__Union
	pszTitle uintptr
	pfnDlgProc uintptr
	lParam uintptr
	pfnCallback uintptr
	pcRefParent uintptr
	pszHeaderTitle uintptr
	pszHeaderSubTitle uintptr
}
type
  PROPSHEETPAGEW_V2 = record
    dwSize: DWORD;
    dwFlags: DWORD;
    hInstance: Pointer;
    Anonymous1: _Anonymous1_e__Union;
    Anonymous2: _Anonymous2_e__Union;
    pszTitle: Pointer;
    pfnDlgProc: Pointer;
    lParam: NativeInt;
    pfnCallback: Pointer;
    pcRefParent: Pointer;
    pszHeaderTitle: Pointer;
    pszHeaderSubTitle: Pointer;
  end;
const PROPSHEETPAGEW_V2 = extern struct {
    dwSize: u32,
    dwFlags: u32,
    hInstance: ?*anyopaque,
    Anonymous1: _Anonymous1_e__Union,
    Anonymous2: _Anonymous2_e__Union,
    pszTitle: ?*anyopaque,
    pfnDlgProc: ?*anyopaque,
    lParam: isize,
    pfnCallback: ?*anyopaque,
    pcRefParent: ?*anyopaque,
    pszHeaderTitle: ?*anyopaque,
    pszHeaderSubTitle: ?*anyopaque,
};
type
  PROPSHEETPAGEW_V2 {.bycopy.} = object
    dwSize: uint32
    dwFlags: uint32
    hInstance: pointer
    Anonymous1: _Anonymous1_e__Union
    Anonymous2: _Anonymous2_e__Union
    pszTitle: pointer
    pfnDlgProc: pointer
    lParam: int
    pfnCallback: pointer
    pcRefParent: pointer
    pszHeaderTitle: pointer
    pszHeaderSubTitle: pointer
struct PROPSHEETPAGEW_V2
{
    uint dwSize;
    uint dwFlags;
    void* hInstance;
    _Anonymous1_e__Union Anonymous1;
    _Anonymous2_e__Union Anonymous2;
    void* pszTitle;
    void* pfnDlgProc;
    ptrdiff_t lParam;
    void* pfnCallback;
    void* pcRefParent;
    void* pszHeaderTitle;
    void* pszHeaderSubTitle;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; PROPSHEETPAGEW_V2 サイズ: 48 バイト(x86)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; hInstance : HINSTANCE (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Anonymous1 : _Anonymous1_e__Union (+12, 4byte)  varptr(st)+12 を基点に操作(4byte:入れ子/配列)
; Anonymous2 : _Anonymous2_e__Union (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; pszTitle : LPWSTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; pfnDlgProc : DLGPROC (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; lParam : LPARAM (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; pfnCallback : LPFNPSPCALLBACKW (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; pcRefParent : DWORD* (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; pszHeaderTitle : LPWSTR (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; pszHeaderSubTitle : LPWSTR (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; PROPSHEETPAGEW_V2 サイズ: 88 バイト(x64)
dim st, 22    ; 4byte整数×22(構造体サイズ 88 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; hInstance : HINSTANCE (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; Anonymous1 : _Anonymous1_e__Union (+16, 8byte)  varptr(st)+16 を基点に操作(8byte:入れ子/配列)
; Anonymous2 : _Anonymous2_e__Union (+24, 8byte)  varptr(st)+24 を基点に操作(8byte:入れ子/配列)
; pszTitle : LPWSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; pfnDlgProc : DLGPROC (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; lParam : LPARAM (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; pfnCallback : LPFNPSPCALLBACKW (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; pcRefParent : DWORD* (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; pszHeaderTitle : LPWSTR (+72, 8byte)  qpoke st,72,値 / qpeek(st,72)  ※IronHSPのみ。3.7/3.8は lpoke st,72,下位 : lpoke st,76,上位
; pszHeaderSubTitle : LPWSTR (+80, 8byte)  qpoke st,80,値 / qpeek(st,80)  ※IronHSPのみ。3.7/3.8は lpoke st,80,下位 : lpoke st,84,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global PROPSHEETPAGEW_V2
    #field int dwSize
    #field int dwFlags
    #field intptr hInstance
    #field byte Anonymous1 8
    #field byte Anonymous2 8
    #field intptr pszTitle
    #field intptr pfnDlgProc
    #field intptr lParam
    #field intptr pfnCallback
    #field intptr pcRefParent
    #field intptr pszHeaderTitle
    #field intptr pszHeaderSubTitle
#endstruct

stdim st, PROPSHEETPAGEW_V2        ; NSTRUCT 変数を確保
st->dwSize = 100
mes "dwSize=" + st->dwSize
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。