Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
pszCaptionLPCWSTRinoptional
ahkeysHKEY*inoptional
ckeysDWORDin
pclsidDefaultGUID*inoptional
pdtobjIDataObject*in
psbIShellBrowser*inoptional
pStartPageLPCWSTRinoptional

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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 方式にも切替可。
出力引数:
; BOOL SHOpenPropSheetW(LPCWSTR pszCaption, HKEY* ahkeys, DWORD ckeys, GUID* pclsidDefault, IDataObject* pdtobj, IShellBrowser* psb, LPCWSTR pStartPage)
#uselib "SHELL32.dll"
#cfunc global SHOpenPropSheetW "SHOpenPropSheetW" wstr, intptr, int, var, intptr, intptr, wstr
; res = SHOpenPropSheetW(pszCaption, ahkeys, ckeys, pclsidDefault, pdtobj, psb, pStartPage)
; pszCaption : LPCWSTR optional -> "wstr"
; ahkeys : HKEY* optional -> "intptr"
; ckeys : DWORD -> "int"
; pclsidDefault : GUID* optional -> "var"
; pdtobj : IDataObject* -> "intptr"
; psb : IShellBrowser* optional -> "intptr"
; pStartPage : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHOpenPropSheetW = shell32.NewProc("SHOpenPropSheetW")
)

// pszCaption (LPCWSTR optional), ahkeys (HKEY* optional), ckeys (DWORD), pclsidDefault (GUID* optional), pdtobj (IDataObject*), psb (IShellBrowser* optional), pStartPage (LPCWSTR optional)
r1, _, err := procSHOpenPropSheetW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszCaption))),
	uintptr(ahkeys),
	uintptr(ckeys),
	uintptr(pclsidDefault),
	uintptr(pdtobj),
	uintptr(psb),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pStartPage))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHOpenPropSheetW(
  pszCaption: PWideChar;   // LPCWSTR optional
  ahkeys: Pointer;   // HKEY* optional
  ckeys: DWORD;   // DWORD
  pclsidDefault: PGUID;   // GUID* optional
  pdtobj: Pointer;   // IDataObject*
  psb: Pointer;   // IShellBrowser* optional
  pStartPage: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHOpenPropSheetW';
result := DllCall("SHELL32\SHOpenPropSheetW"
    , "WStr", pszCaption   ; LPCWSTR optional
    , "Ptr", ahkeys   ; HKEY* optional
    , "UInt", ckeys   ; DWORD
    , "Ptr", pclsidDefault   ; GUID* optional
    , "Ptr", pdtobj   ; IDataObject*
    , "Ptr", psb   ; IShellBrowser* optional
    , "WStr", pStartPage   ; LPCWSTR optional
    , "Int")   ; return: BOOL
●SHOpenPropSheetW(pszCaption, ahkeys, ckeys, pclsidDefault, pdtobj, psb, pStartPage) = DLL("SHELL32.dll", "bool SHOpenPropSheetW(char*, void*, dword, void*, void*, void*, char*)")
# 呼び出し: SHOpenPropSheetW(pszCaption, ahkeys, ckeys, pclsidDefault, pdtobj, psb, pStartPage)
# pszCaption : LPCWSTR optional -> "char*"
# ahkeys : HKEY* optional -> "void*"
# ckeys : DWORD -> "dword"
# pclsidDefault : GUID* optional -> "void*"
# pdtobj : IDataObject* -> "void*"
# psb : IShellBrowser* optional -> "void*"
# pStartPage : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。