ホーム › UI.Shell › SHOpenPropSheetW

SHOpenPropSheetW

関数

シェルアイテムのプロパティシートを開いて表示する。

DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL SHOpenPropSheetW(
    LPCWSTR pszCaption,   // optional
    HKEY* ahkeys,   // optional
    DWORD ckeys,
    const GUID* pclsidDefault,   // optional
    IDataObject* pdtobj,
    IShellBrowser* psb,   // optional
    LPCWSTR pStartPage   // optional
);

パラメーター

名前	型	方向	説明
pszCaption	LPCWSTR	inoptional	プロパティシートのキャプションを格納する文字列へのポインター。キャプションが不要な場合、この値は NULL にできます。
ahkeys	HKEY*	inoptional	個々のプロパティシートの CLSID を表すレジストリキーの配列。
ckeys	DWORD	in	ahkeys で指定された配列内のプロパティシートの数を指定する UINT 値。
pclsidDefault	GUID*	inoptional	既定の CLSID へのポインター。この値は NULL にできます。
pdtobj	IDataObject*	in	IDataObject へのポインター。プロパティシートに対する操作を実行するために使用できる OLE オブジェクトです。
psb	IShellBrowser*	inoptional	使用されません。
pStartPage	LPCWSTR	inoptional	開始ページを指定する文字列へのポインター。この値は NULL にできます。

戻り値の型: BOOL

公式ドキュメント

SHOpenPropSheet は変更されるか、利用できなくなる可能性があります。(Unicode)

戻り値

型: BOOL

プロパティシートが正常に作成された場合は TRUE を返します。それ以外の場合は FALSE を返します。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

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

BOOL SHOpenPropSheetW(
    LPCWSTR pszCaption,   // optional
    HKEY* ahkeys,   // optional
    DWORD ckeys,
    const GUID* pclsidDefault,   // optional
    IDataObject* pdtobj,
    IShellBrowser* psb,   // optional
    LPCWSTR pStartPage   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SHOpenPropSheetW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszCaption,   // LPCWSTR optional
    IntPtr ahkeys,   // HKEY* optional
    uint ckeys,   // DWORD
    IntPtr pclsidDefault,   // GUID* optional
    IntPtr pdtobj,   // IDataObject*
    IntPtr psb,   // IShellBrowser* optional
    [MarshalAs(UnmanagedType.LPWStr)] string pStartPage   // LPCWSTR optional
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHOpenPropSheetW(
    <MarshalAs(UnmanagedType.LPWStr)> pszCaption As String,   ' LPCWSTR optional
    ahkeys As IntPtr,   ' HKEY* optional
    ckeys As UInteger,   ' DWORD
    pclsidDefault As IntPtr,   ' GUID* optional
    pdtobj As IntPtr,   ' IDataObject*
    psb As IntPtr,   ' IShellBrowser* optional
    <MarshalAs(UnmanagedType.LPWStr)> pStartPage As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszCaption : LPCWSTR optional
' ahkeys : HKEY* optional
' ckeys : DWORD
' pclsidDefault : GUID* optional
' pdtobj : IDataObject*
' psb : IShellBrowser* optional
' pStartPage : LPCWSTR optional
Declare PtrSafe Function SHOpenPropSheetW Lib "shell32" ( _
    ByVal pszCaption As LongPtr, _
    ByVal ahkeys As LongPtr, _
    ByVal ckeys As Long, _
    ByVal pclsidDefault As LongPtr, _
    ByVal pdtobj As LongPtr, _
    ByVal psb As LongPtr, _
    ByVal pStartPage As LongPtr) As Long
' 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

SHOpenPropSheetW = ctypes.windll.shell32.SHOpenPropSheetW
SHOpenPropSheetW.restype = wintypes.BOOL
SHOpenPropSheetW.argtypes = [
    wintypes.LPCWSTR,  # pszCaption : LPCWSTR optional
    ctypes.c_void_p,  # ahkeys : HKEY* optional
    wintypes.DWORD,  # ckeys : DWORD
    ctypes.c_void_p,  # pclsidDefault : GUID* optional
    ctypes.c_void_p,  # pdtobj : IDataObject*
    ctypes.c_void_p,  # psb : IShellBrowser* optional
    wintypes.LPCWSTR,  # pStartPage : LPCWSTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHOpenPropSheetW = Fiddle::Function.new(
  lib['SHOpenPropSheetW'],
  [
    Fiddle::TYPE_VOIDP,  # pszCaption : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # ahkeys : HKEY* optional
    -Fiddle::TYPE_INT,  # ckeys : DWORD
    Fiddle::TYPE_VOIDP,  # pclsidDefault : GUID* optional
    Fiddle::TYPE_VOIDP,  # pdtobj : IDataObject*
    Fiddle::TYPE_VOIDP,  # psb : IShellBrowser* optional
    Fiddle::TYPE_VOIDP,  # pStartPage : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shell32")]
extern "system" {
    fn SHOpenPropSheetW(
        pszCaption: *const u16,  // LPCWSTR optional
        ahkeys: *mut *mut core::ffi::c_void,  // HKEY* optional
        ckeys: u32,  // DWORD
        pclsidDefault: *const GUID,  // GUID* optional
        pdtobj: *mut core::ffi::c_void,  // IDataObject*
        psb: *mut core::ffi::c_void,  // IShellBrowser* optional
        pStartPage: *const u16  // LPCWSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern bool SHOpenPropSheetW([MarshalAs(UnmanagedType.LPWStr)] string pszCaption, IntPtr ahkeys, uint ckeys, IntPtr pclsidDefault, IntPtr pdtobj, IntPtr psb, [MarshalAs(UnmanagedType.LPWStr)] string pStartPage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHOpenPropSheetW' -Namespace Win32 -PassThru
# $api::SHOpenPropSheetW(pszCaption, ahkeys, ckeys, pclsidDefault, pdtobj, psb, pStartPage)

#uselib "SHELL32.dll"
#func global SHOpenPropSheetW "SHOpenPropSheetW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; SHOpenPropSheetW pszCaption, ahkeys, ckeys, varptr(pclsidDefault), pdtobj, psb, pStartPage   ; 戻り値は stat
; pszCaption : LPCWSTR optional -> "wptr"
; ahkeys : HKEY* optional -> "wptr"
; ckeys : DWORD -> "wptr"
; pclsidDefault : GUID* optional -> "wptr"
; pdtobj : IDataObject* -> "wptr"
; psb : IShellBrowser* optional -> "wptr"
; pStartPage : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHOpenPropSheetW "SHOpenPropSheetW" wstr, sptr, int, var, sptr, sptr, wstr
; res = SHOpenPropSheetW(pszCaption, ahkeys, ckeys, pclsidDefault, pdtobj, psb, pStartPage)
; pszCaption : LPCWSTR optional -> "wstr"
; ahkeys : HKEY* optional -> "sptr"
; ckeys : DWORD -> "int"
; pclsidDefault : GUID* optional -> "var"
; pdtobj : IDataObject* -> "sptr"
; psb : IShellBrowser* optional -> "sptr"
; pStartPage : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHOpenPropSheetW "SHOpenPropSheetW" wstr, sptr, int, sptr, sptr, sptr, wstr
; res = SHOpenPropSheetW(pszCaption, ahkeys, ckeys, varptr(pclsidDefault), pdtobj, psb, pStartPage)
; pszCaption : LPCWSTR optional -> "wstr"
; ahkeys : HKEY* optional -> "sptr"
; ckeys : DWORD -> "int"
; pclsidDefault : GUID* optional -> "sptr"
; pdtobj : IDataObject* -> "sptr"
; psb : IShellBrowser* optional -> "sptr"
; pStartPage : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。