Win32 API 日本語リファレンス
ホームSystem.Ole › OleUIPromptUserW

OleUIPromptUserW

関数可変長引数
指定テンプレートのOLE標準ダイアログを表示する。
DLLoledlg.dll文字セットUnicode (-W)呼出規約cdecl対応OSWindows 2000 以降

シグネチャ

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

INT OleUIPromptUserW(
    INT nTemplate,
    HWND hwndParent,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

パラメーター

名前方向説明
nTemplateINTin表示するダイアログボックスのリソース番号。「解説」を参照してください。
hwndParentHWNDinダイアログボックスの親ウィンドウへのハンドル。

戻り値の型: INT

公式ドキュメント

指定したテンプレートを使用してダイアログボックスを表示し、ユーザーからの応答(ボタン識別子)を返します。この関数は、OLE の警告メッセージ(例: Class Not Registered)を表示するために使用されます。(Unicode)

戻り値

標準の成功 / エラー定義

戻り値 説明
OLEUI_FALSE
不明な失敗(未使用)。
OLEUI_OK
ユーザーが OK ボタンを押しました。
OLEUI_SUCCESS
エラーなし。OLEUI_OK と同じです。
OLEUI_CANCEL
ユーザーが キャンセル ボタンを押しました。

標準のフィールド検証エラー

戻り値 説明
OLEUI_ERR_STANDARDMIN
すべてのダイアログボックスに共通するエラーは、OLEUI_ERR_STANDARDMIN から OLEUI_ERR_STANDARDMAX の範囲にあります。この値により、アプリケーションは標準メッセージを判別し、ユーザーにエラーメッセージを表示できます。
OLEUI_ERR_STRUCTURENULL
関数に渡された OLEUIXXX 構造体へのポインターが NULL でした。
OLEUI_ERR_STRUCTUREINVALID
OLEUIXXX 構造体への読み取りまたは書き込みアクセスに対する権限が不足しています。
OLEUI_ERR_CBSTRUCTINCORRECT
cbstruct の値が正しくありません。
OLEUI_ERR_HWNDOWNERINVALID
hWndOwner の値が無効です。
OLEUI_ERR_LPSZCAPTIONINVALID
lpszCaption の値が無効です。
OLEUI_ERR_LPFNHOOKINVALID
lpfnHook の値が無効です。
OLEUI_ERR_HINSTANCEINVALID
hInstance の値が無効です。
OLEUI_ERR_LPSZTEMPLATEINVALID
lpszTemplate の値が無効です。
OLEUI_ERR_HRESOURCEINVALID
hResource の値が無効です。

初期化エラー

戻り値 説明
OLEUI_ERR_FINDTEMPLATEFAILURE
ダイアログボックスのテンプレートが見つかりませんでした。
OLEUI_ERR_LOADTEMPLATEFAILURE
ダイアログボックスのテンプレートを読み込めませんでした。
OLEUI_ERR_DIALOGFAILURE
ダイアログボックスの初期化に失敗しました。
OLEUI_ERR_LOCALMEMALLOC
LocalAlloc または標準の IMalloc アロケーターの呼び出しに失敗しました。
OLEUI_ERR_GLOBALMEMALLOC
GlobalAlloc または標準の IMalloc アロケーターの呼び出しに失敗しました。
OLEUI_ERR_LOADSTRING
ライブラリからローカライズされたリソースを取得するための LoadString を呼び出せませんでした。
OLEUI_ERR_OLEMEMALLOC
標準の IMalloc アロケーターの呼び出しに失敗しました。

関数固有のエラー

戻り値 説明
OLEUI_ERR_STANDARDMAX
すべてのダイアログボックスに共通するエラーは、OLEUI_ERR_STANDARDMIN から OLEUI_ERR_STANDARDMAX の範囲にあります。この値により、アプリケーションは標準メッセージを判別し、ユーザーにエラーメッセージを表示できます。

解説(Remarks)

以下のダイアログボックステンプレートは、Windows Interface Guidelines--A Guide for Designing Software で定義されています。nTemplate パラメーターは現在定義されているリソースである必要がありますが、prompt.dlg に追加のテンプレートを加えることもできます。

IDD_LINKSOURCEUNAVAILABLE 
IDD_CANNOTUPDATELINK 
IDD_SERVERNOTREG 
IDD_CANNOTRESPONDVERB 
IDD_SERVERNOTFOUND 
メモ

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

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

各言語での呼び出し定義

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

INT OleUIPromptUserW(
    INT nTemplate,
    HWND hwndParent,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
[DllImport("oledlg.dll", CharSet = CharSet.Unicode, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern int OleUIPromptUserW(
    int nTemplate,   // INT
    IntPtr hwndParent,   // HWND
    __arglist
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<DllImport("oledlg.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function OleUIPromptUserW(
    nTemplate As Integer,   ' INT
    hwndParent As IntPtr   ' HWND
) As Integer
End Function
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
' nTemplate : INT
' hwndParent : HWND
Declare PtrSafe Function OleUIPromptUserW Lib "oledlg" ( _
    ByVal nTemplate As Long, _
    ByVal hwndParent As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import ctypes
from ctypes import wintypes

OleUIPromptUserW = ctypes.cdll.oledlg.OleUIPromptUserW
OleUIPromptUserW.restype = ctypes.c_int
OleUIPromptUserW.argtypes = [
    ctypes.c_int,  # nTemplate : INT
    wintypes.HANDLE,  # hwndParent : HWND
]
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('oledlg.dll')
OleUIPromptUserW = Fiddle::Function.new(
  lib['OleUIPromptUserW'],
  [
    Fiddle::TYPE_INT,  # nTemplate : INT
    Fiddle::TYPE_VOIDP,  # hwndParent : HWND
  ],
  Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#[link(name = "oledlg")]
extern "C" {
    fn OleUIPromptUserW(
        nTemplate: i32,  // INT
        hwndParent: *mut core::ffi::c_void,  // HWND
        ...
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
$sig = @"
[DllImport("oledlg.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl)]
public static extern int OleUIPromptUserW(int nTemplate, IntPtr hwndParent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'oledlg_OleUIPromptUserW' -Namespace Win32 -PassThru
# $api::OleUIPromptUserW(nTemplate, hwndParent)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "oledlg.dll"
#func global OleUIPromptUserW "OleUIPromptUserW" wptr, wptr
; OleUIPromptUserW nTemplate, hwndParent   ; 戻り値は stat
; nTemplate : INT -> "wptr"
; hwndParent : HWND -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "oledlg.dll"
#cfunc global OleUIPromptUserW "OleUIPromptUserW" int, sptr
; res = OleUIPromptUserW(nTemplate, hwndParent)
; nTemplate : INT -> "int"
; hwndParent : HWND -> "sptr"
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
; INT OleUIPromptUserW(INT nTemplate, HWND hwndParent)
#uselib "oledlg.dll"
#cfunc global OleUIPromptUserW "OleUIPromptUserW" int, intptr
; res = OleUIPromptUserW(nTemplate, hwndParent)
; nTemplate : INT -> "int"
; hwndParent : HWND -> "intptr"
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oledlg = windows.NewLazySystemDLL("oledlg.dll")
	procOleUIPromptUserW = oledlg.NewProc("OleUIPromptUserW")
)

// nTemplate (INT), hwndParent (HWND)
r1, _, err := procOleUIPromptUserW.Call(
	uintptr(nTemplate),
	uintptr(hwndParent),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
function OleUIPromptUserW(
  nTemplate: Integer;   // INT
  hwndParent: THandle   // HWND
): Integer; cdecl; varargs;
  external 'oledlg.dll' name 'OleUIPromptUserW';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
result := DllCall("oledlg\OleUIPromptUserW"
    , "Int", nTemplate   ; INT
    , "Ptr", hwndParent   ; HWND
    , "Cdecl Int")   ; return: INT
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
●OleUIPromptUserW(nTemplate, hwndParent) = DLL("oledlg.dll", "int OleUIPromptUserW(int, void*)")
# 呼び出し: OleUIPromptUserW(nTemplate, hwndParent)
# nTemplate : INT -> "int"
# hwndParent : HWND -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
# ※可変長引数。DLL()は固定引数のみ。追加引数は EXEC_PTR で渡してください。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const std = @import("std");

extern "oledlg" fn OleUIPromptUserW(
    nTemplate: i32, // INT
    hwndParent: ?*anyopaque, // HWND
    ...
) callconv(.c) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
proc OleUIPromptUserW(
    nTemplate: int32,  # INT
    hwndParent: pointer  # HWND
): int32 {.importc: "OleUIPromptUserW", cdecl, varargs, dynlib: "oledlg.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
pragma(lib, "oledlg");
extern(C)
int OleUIPromptUserW(
    int nTemplate,   // INT
    void* hwndParent,   // HWND
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
ccall((:OleUIPromptUserW, "oledlg.dll"), Int32,
      (Int32, Ptr{Cvoid}),
      nTemplate, hwndParent)
# nTemplate : INT -> Int32
# hwndParent : HWND -> Ptr{Cvoid}
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
local ffi = require("ffi")
ffi.cdef[[
int32_t OleUIPromptUserW(
    int32_t nTemplate,
    void* hwndParent,
    ...);
]]
local oledlg = ffi.load("oledlg")
-- oledlg.OleUIPromptUserW(nTemplate, hwndParent)
-- nTemplate : INT
-- hwndParent : HWND
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const koffi = require('koffi');
const lib = koffi.load('oledlg.dll');
const OleUIPromptUserW = lib.func('__cdecl', 'OleUIPromptUserW', 'int32_t', ['int32_t', 'void *', '...']);
// OleUIPromptUserW(nTemplate, hwndParent)
// nTemplate : INT -> 'int32_t'
// hwndParent : HWND -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const lib = Deno.dlopen("oledlg.dll", {
  OleUIPromptUserW: { parameters: ["i32", "pointer"], result: "i32" },
});
// lib.symbols.OleUIPromptUserW(nTemplate, hwndParent)
// nTemplate : INT -> "i32"
// hwndParent : HWND -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<?php
$ffi = FFI::cdef(<<<C
int32_t OleUIPromptUserW(
    int32_t nTemplate,
    void* hwndParent,
    ...);
C, "oledlg.dll");
// $ffi->OleUIPromptUserW(nTemplate, hwndParent);
// nTemplate : INT
// hwndParent : HWND
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Oledlg extends Library {
    Oledlg INSTANCE = Native.load("oledlg", Oledlg.class, W32APIOptions.UNICODE_OPTIONS);
    int OleUIPromptUserW(
        int nTemplate,   // INT
        Pointer hwndParent,   // HWND
        Object... args   // 可変長引数(printf形式)
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
@[Link("oledlg")]
lib Liboledlg
  fun OleUIPromptUserW = OleUIPromptUserW(
    nTemplate : Int32,   # INT
    hwndParent : Void*,   # HWND
    ...
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OleUIPromptUserWNative = Int32 Function(Int32, Pointer<Void>);
typedef OleUIPromptUserWDart = int Function(int, Pointer<Void>);
final OleUIPromptUserW = DynamicLibrary.open('oledlg.dll')
    .lookupFunction<OleUIPromptUserWNative, OleUIPromptUserWDart>('OleUIPromptUserW');
// nTemplate : INT -> Int32
// hwndParent : HWND -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
{$mode objfpc}{$H+}
function OleUIPromptUserW(
  nTemplate: Integer;   // INT
  hwndParent: THandle   // HWND
): Integer; cdecl; varargs;
  external 'oledlg.dll' name 'OleUIPromptUserW';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "OleUIPromptUserW"
  c_OleUIPromptUserW :: Int32 -> Ptr () -> IO Int32
-- nTemplate : INT -> Int32
-- hwndParent : HWND -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
open Ctypes
open Foreign

let oleuipromptuserw =
  foreign "OleUIPromptUserW"
    (int32_t @-> (ptr void) @-> returning int32_t)
(* nTemplate : INT -> int32_t *)
(* hwndParent : HWND -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(* ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
(cffi:define-foreign-library oledlg (t "oledlg.dll"))
(cffi:use-foreign-library oledlg)

(cffi:defcfun ("OleUIPromptUserW" ole-uiprompt-user-w :convention :cdecl) :int32
  (n-template :int32)   ; INT
  (hwnd-parent :pointer)   ; HWND
  &rest)   ; 可変長引数(printf形式)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
use Win32::API;
my $OleUIPromptUserW = Win32::API::More->new('oledlg',
    'int OleUIPromptUserW(int nTemplate, HANDLE hwndParent)');
# my $ret = $OleUIPromptUserW->Call($nTemplate, $hwndParent);
# nTemplate : INT -> int
# hwndParent : HWND -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

関連項目

文字セット違い