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

PropertySheetA

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

シグネチャ

// COMCTL32.dll  (ANSI / -A)
#include <windows.h>

INT_PTR PropertySheetA(
    PROPSHEETHEADERA_V2* param0
);

パラメーター

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

戻り値の型: INT_PTR

公式ドキュメント

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

戻り値

型: INT_PTR

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

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

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

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

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

解説(Remarks)

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

プロパティシートに 99 ページを超えるページを追加しようとすると、この関数は失敗しますが、エラーの原因は示されません。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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PropertySheet を定義しています。エンコーディング非依存のエイリアスと、エンコーディング非依存ではないコードを混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// COMCTL32.dll  (ANSI / -A)
#include <windows.h>

INT_PTR PropertySheetA(
    PROPSHEETHEADERA_V2* param0
);
[DllImport("COMCTL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr PropertySheetA(
    IntPtr param0   // PROPSHEETHEADERA_V2* in/out
);
<DllImport("COMCTL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PropertySheetA(
    param0 As IntPtr   ' PROPSHEETHEADERA_V2* in/out
) As IntPtr
End Function
' param0 : PROPSHEETHEADERA_V2* in/out
Declare PtrSafe Function PropertySheetA Lib "comctl32" ( _
    ByVal param0 As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procPropertySheetA = comctl32.NewProc("PropertySheetA")
)

// param0 (PROPSHEETHEADERA_V2* in/out)
r1, _, err := procPropertySheetA.Call(
	uintptr(param0),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT_PTR
function PropertySheetA(
  param0: Pointer   // PROPSHEETHEADERA_V2* in/out
): NativeInt; stdcall;
  external 'COMCTL32.dll' name 'PropertySheetA';
result := DllCall("COMCTL32\PropertySheetA"
    , "Ptr", param0   ; PROPSHEETHEADERA_V2* in/out
    , "Ptr")   ; return: INT_PTR
●PropertySheetA(param0) = DLL("COMCTL32.dll", "int PropertySheetA(void*)")
# 呼び出し: PropertySheetA(param0)
# param0 : PROPSHEETHEADERA_V2* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "comctl32" fn PropertySheetA(
    param0: [*c]PROPSHEETHEADERA_V2 // PROPSHEETHEADERA_V2* in/out
) callconv(std.os.windows.WINAPI) isize;
proc PropertySheetA(
    param0: ptr PROPSHEETHEADERA_V2  # PROPSHEETHEADERA_V2* in/out
): int {.importc: "PropertySheetA", stdcall, dynlib: "COMCTL32.dll".}
pragma(lib, "comctl32");
extern(Windows)
ptrdiff_t PropertySheetA(
    PROPSHEETHEADERA_V2* param0   // PROPSHEETHEADERA_V2* in/out
);
ccall((:PropertySheetA, "COMCTL32.dll"), stdcall, Int,
      (Ptr{PROPSHEETHEADERA_V2},),
      param0)
# param0 : PROPSHEETHEADERA_V2* in/out -> Ptr{PROPSHEETHEADERA_V2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
intptr_t PropertySheetA(
    void* param0);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.PropertySheetA(param0)
-- param0 : PROPSHEETHEADERA_V2* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const PropertySheetA = lib.func('__stdcall', 'PropertySheetA', 'intptr_t', ['void *']);
// PropertySheetA(param0)
// param0 : PROPSHEETHEADERA_V2* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("COMCTL32.dll", {
  PropertySheetA: { parameters: ["pointer"], result: "isize" },
});
// lib.symbols.PropertySheetA(param0)
// param0 : PROPSHEETHEADERA_V2* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t PropertySheetA(
    void* param0);
C, "COMCTL32.dll");
// $ffi->PropertySheetA(param0);
// param0 : PROPSHEETHEADERA_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.ASCII_OPTIONS);
    long PropertySheetA(
        Pointer param0   // PROPSHEETHEADERA_V2* in/out
    );
}
@[Link("comctl32")]
lib LibCOMCTL32
  fun PropertySheetA = PropertySheetA(
    param0 : PROPSHEETHEADERA_V2*   # PROPSHEETHEADERA_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 PropertySheetANative = IntPtr Function(Pointer<Void>);
typedef PropertySheetADart = int Function(Pointer<Void>);
final PropertySheetA = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<PropertySheetANative, PropertySheetADart>('PropertySheetA');
// param0 : PROPSHEETHEADERA_V2* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PropertySheetA(
  param0: Pointer   // PROPSHEETHEADERA_V2* in/out
): NativeInt; stdcall;
  external 'COMCTL32.dll' name 'PropertySheetA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let propertysheeta =
  foreign "PropertySheetA"
    ((ptr void) @-> returning intptr_t)
(* param0 : PROPSHEETHEADERA_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 ("PropertySheetA" property-sheet-a :convention :stdcall) :int64
  (param0 :pointer))   ; PROPSHEETHEADERA_V2* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PropertySheetA = Win32::API::More->new('COMCTL32',
    'LPARAM PropertySheetA(LPVOID param0)');
# my $ret = $PropertySheetA->Call($param0);
# param0 : PROPSHEETHEADERA_V2* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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