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

PropertySheetW

関数
プロパティシートを作成し表示する(Unicode版)。
DLLCOMCTL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// COMCTL32.dll  (Unicode / -W)
#include <windows.h>

INT_PTR PropertySheetW(
    PROPSHEETHEADERW_V2* param0
);

パラメーター

名前型方向説明
param0PROPSHEETHEADERW_V2*inoutプロパティシート全体の構成を記述したPROPSHEETHEADERW_V2構造体へのポインタ。Unicode版。

戻り値の型: INT_PTR

公式ドキュメント

プロパティシートを作成し、指定したプロパティシートヘッダー構造体で定義されたページを追加します。(Unicode)

戻り値

型: INT_PTR

モーダルなプロパティシートの場合、戻り値は次のとおりです。

>=1 変更がユーザーによって保存されました。
0 変更はユーザーによって保存されませんでした。
-1 エラーが発生しました。

モードレスなプロパティシートの場合、戻り値はプロパティシートのウィンドウハンドルです。

次の戻り値には特別な意味があります。

戻り値 説明
ID_PSREBOOTSYSTEM
 ページがプロパティシートに PSM_REBOOTSYSTEM メッセージを送信しました。ユーザーの変更を反映するには、コンピューターを再起動する必要があります。
ID_PSRESTARTWINDOWS
 ページがプロパティシートに PSM_RESTARTWINDOWS メッセージを送信しました。ユーザーの変更を反映するには、Windows を再起動する必要があります。

解説(Remarks)

拡張エラー情報を取得するには、GetLastError を呼び出します。

100 ページ以上をプロパティシートに追加しようとすると、この関数は失敗しますが、エラーの原因は示されません。PropertySheet は -1 を返しますが、GetLastError は 0 を返します。

注 以下の注釈は、Aero ウィザードスタイル(PSH_AEROWIZARD)を使用しないウィザード、またはウィザードではないプロパティシートにのみ該当します。
既定では、PropertySheet 関数はモーダルダイアログボックスを作成します。PROPSHEETHEADER 構造体の dwFlags メンバーで PSH_MODELESS フラグが指定されている場合、PropertySheet はモードレスダイアログボックスを作成し、作成後すぐに戻ります。この場合、PropertySheet の戻り値はモードレスダイアログボックスのウィンドウハンドルです。

モードレスなプロパティシートでは、メッセージループで PSM_ISDIALOGMESSAGE を使用してプロパティシートダイアログボックスにメッセージを渡す必要があります。また、メッセージループで PSM_GETCURRENTPAGEHWND を使用して、ダイアログボックスを破棄するタイミングを判断する必要があります。ユーザーが OK ボタンまたは キャンセル ボタンをクリックすると、PSM_GETCURRENTPAGEHWND は NULL を返します。その後、DestroyWindow 関数を使用してダイアログボックスを破棄できます。

バージョン 5.80。 PropertySheet の戻り値が持つ情報は、モーダルとモードレスのプロパティシートで異なります。場合によっては、モードレスなプロパティシートでも、モーダルであれば PropertySheet から受け取っていたであろう情報が必要になることがあります。特に、ID_PSREBOOTSYSTEM または ID_PSRESTARTWINDOWS が返されたかどうかを知る必要がある場合があります。モードレスなプロパティシートは、PSM_GETCURRENTPAGEHWND が NULL を返すまで待ってから PSM_GETRESULT メッセージを送信することで、モーダルなプロパティシートが PropertySheet から受け取っていたであろう値を取得できます。

メモ

prsht.h ヘッダーは、PropertySheet を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こすことがあります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// COMCTL32.dll  (Unicode / -W)
#include <windows.h>

INT_PTR PropertySheetW(
    PROPSHEETHEADERW_V2* param0
);
[DllImport("COMCTL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr PropertySheetW(
    IntPtr param0   // PROPSHEETHEADERW_V2* in/out
);
<DllImport("COMCTL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PropertySheetW(
    param0 As IntPtr   ' PROPSHEETHEADERW_V2* in/out
) As IntPtr
End Function
' param0 : PROPSHEETHEADERW_V2* in/out
Declare PtrSafe Function PropertySheetW Lib "comctl32" ( _
    ByVal param0 As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PropertySheetW = ctypes.windll.comctl32.PropertySheetW
PropertySheetW.restype = ctypes.c_ssize_t
PropertySheetW.argtypes = [
    ctypes.c_void_p,  # param0 : PROPSHEETHEADERW_V2* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
PropertySheetW = Fiddle::Function.new(
  lib['PropertySheetW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : PROPSHEETHEADERW_V2* in/out
  ],
  Fiddle::TYPE_INTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "comctl32")]
extern "system" {
    fn PropertySheetW(
        param0: *mut PROPSHEETHEADERW_V2  // PROPSHEETHEADERW_V2* in/out
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("COMCTL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr PropertySheetW(IntPtr param0);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_PropertySheetW' -Namespace Win32 -PassThru
# $api::PropertySheetW(param0)
#uselib "COMCTL32.dll"
#func global PropertySheetW "PropertySheetW" wptr
; PropertySheetW varptr(param0)   ; 戻り値は stat
; param0 : PROPSHEETHEADERW_V2* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "COMCTL32.dll"
#cfunc global PropertySheetW "PropertySheetW" var
; res = PropertySheetW(param0)
; param0 : PROPSHEETHEADERW_V2* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; INT_PTR PropertySheetW(PROPSHEETHEADERW_V2* param0)
#uselib "COMCTL32.dll"
#cfunc global PropertySheetW "PropertySheetW" var
; res = PropertySheetW(param0)
; param0 : PROPSHEETHEADERW_V2* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procPropertySheetW = comctl32.NewProc("PropertySheetW")
)

// param0 (PROPSHEETHEADERW_V2* in/out)
r1, _, err := procPropertySheetW.Call(
	uintptr(param0),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT_PTR
function PropertySheetW(
  param0: Pointer   // PROPSHEETHEADERW_V2* in/out
): NativeInt; stdcall;
  external 'COMCTL32.dll' name 'PropertySheetW';
result := DllCall("COMCTL32\PropertySheetW"
    , "Ptr", param0   ; PROPSHEETHEADERW_V2* in/out
    , "Ptr")   ; return: INT_PTR
●PropertySheetW(param0) = DLL("COMCTL32.dll", "int PropertySheetW(void*)")
# 呼び出し: PropertySheetW(param0)
# param0 : PROPSHEETHEADERW_V2* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "comctl32" fn PropertySheetW(
    param0: [*c]PROPSHEETHEADERW_V2 // PROPSHEETHEADERW_V2* in/out
) callconv(std.os.windows.WINAPI) isize;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc PropertySheetW(
    param0: ptr PROPSHEETHEADERW_V2  # PROPSHEETHEADERW_V2* in/out
): int {.importc: "PropertySheetW", stdcall, dynlib: "COMCTL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "comctl32");
extern(Windows)
ptrdiff_t PropertySheetW(
    PROPSHEETHEADERW_V2* param0   // PROPSHEETHEADERW_V2* in/out
);
ccall((:PropertySheetW, "COMCTL32.dll"), stdcall, Int,
      (Ptr{PROPSHEETHEADERW_V2},),
      param0)
# param0 : PROPSHEETHEADERW_V2* in/out -> Ptr{PROPSHEETHEADERW_V2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
intptr_t PropertySheetW(
    void* param0);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.PropertySheetW(param0)
-- param0 : PROPSHEETHEADERW_V2* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const PropertySheetW = lib.func('__stdcall', 'PropertySheetW', 'intptr_t', ['void *']);
// PropertySheetW(param0)
// param0 : PROPSHEETHEADERW_V2* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("COMCTL32.dll", {
  PropertySheetW: { parameters: ["pointer"], result: "isize" },
});
// lib.symbols.PropertySheetW(param0)
// param0 : PROPSHEETHEADERW_V2* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t PropertySheetW(
    void* param0);
C, "COMCTL32.dll");
// $ffi->PropertySheetW(param0);
// param0 : PROPSHEETHEADERW_V2* in/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 Comctl32 extends StdCallLibrary {
    Comctl32 INSTANCE = Native.load("comctl32", Comctl32.class, W32APIOptions.UNICODE_OPTIONS);
    long PropertySheetW(
        Pointer param0   // PROPSHEETHEADERW_V2* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("comctl32")]
lib LibCOMCTL32
  fun PropertySheetW = PropertySheetW(
    param0 : PROPSHEETHEADERW_V2*   # PROPSHEETHEADERW_V2* in/out
  ) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PropertySheetWNative = IntPtr Function(Pointer<Void>);
typedef PropertySheetWDart = int Function(Pointer<Void>);
final PropertySheetW = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<PropertySheetWNative, PropertySheetWDart>('PropertySheetW');
// param0 : PROPSHEETHEADERW_V2* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PropertySheetW(
  param0: Pointer   // PROPSHEETHEADERW_V2* in/out
): NativeInt; stdcall;
  external 'COMCTL32.dll' name 'PropertySheetW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PropertySheetW"
  c_PropertySheetW :: Ptr () -> IO CIntPtr
-- param0 : PROPSHEETHEADERW_V2* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let propertysheetw =
  foreign "PropertySheetW"
    ((ptr void) @-> returning intptr_t)
(* param0 : PROPSHEETHEADERW_V2* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("PropertySheetW" property-sheet-w :convention :stdcall) :int64
  (param0 :pointer))   ; PROPSHEETHEADERW_V2* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PropertySheetW = Win32::API::More->new('COMCTL32',
    'LPARAM PropertySheetW(LPVOID param0)');
# my $ret = $PropertySheetW->Call($param0);
# param0 : PROPSHEETHEADERW_V2* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型