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

OleUIInsertObjectW

関数
オブジェクトの挿入ダイアログを表示する。
DLLoledlg.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD OleUIInsertObjectW(
    OLEUIINSERTOBJECTW* param0
);

パラメーター

名前方向説明
param0OLEUIINSERTOBJECTW*inオブジェクト挿入ダイアログを構成するOLEUIINSERTOBJECTW構造体へのポインタ。入出力兼用。

戻り値の型: DWORD

公式ドキュメント

標準の Insert Object ダイアログボックスを表示します。ユーザーはオブジェクトのソースとクラス名を選択でき、さらにオブジェクトをそのまま表示するか、アイコンとして表示するかを選択できます。(Unicode)

戻り値

標準の成功/エラー定義

戻り値 説明
OLEUI_FALSE
原因不明の失敗(未使用)。
OLEUI_OK
ユーザーが OK ボタンを押しました。
OLEUI_SUCCESS
エラーなし。OLEUI_OK と同じです。
OLEUI_CANCEL
ユーザーが 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 の範囲に含まれます。この値により、アプリケーションは標準的なメッセージかどうかをテストし、ユーザーにエラーメッセージを表示できます。
OLEUI_IOERR_LPSZFILEINVALID
lpszFile の値が無効であるか、ユーザーの書き込みアクセス権限が不足しています。この lpszFile メンバーは、リンクまたは挿入されるファイルの名前を指します。
OLEUI_IOERR_PPVOBJINVALID
ppvOjb の値が無効です。このメンバーは、オブジェクトへのポインターが返される場所を指します。
OLEUI_IOERR_LPIOLECLIENTSITEINVALID
lpIOleClientSite の値が無効です。このメンバーは、オブジェクトのクライアントサイトを指します。
OLEUI_IOERR_LPISTORAGEINVALID
lpIStorage の値が無効です。このメンバーは、オブジェクトに使用するストレージを指します。
OLEUI_IOERR_SCODEHASERROR
lpIOsc メンバーに追加のエラー情報があります。
OLEUI_IOERR_LPCLSIDEXCLUDEINVALID
lpClsidExclude の値が無効です。このメンバーには、除外する CLSID のリストが含まれます。
OLEUI_IOERR_CCHFILEINVALID
cchFile または lpszFile の値が無効です。cchFile メンバーは lpszFile バッファーのサイズを指定します。lpszFile メンバーは、リンクまたは挿入されるファイルの名前を指します。

解説(Remarks)

OleUIInsertObject を使用すると、ユーザーのシステムに登録されているオブジェクトアプリケーションの一覧を含むリストボックスから、挿入するオブジェクトの種類を選択できます。そのリストボックスを生成するために、OleUIInsertObject はレジストリを走査し、次の条件を満たすすべてのオブジェクトサーバーを追加します。

既定では、OleUIInsertObject はオブジェクトサーバーの検証を行いません。ただし、OLEUIINSERTOBJECT 構造体の dwFlags メンバーに IOF_VERIFYSERVEREXIST フラグが含まれている場合、OleUIInsertObject はサーバーが存在することを確認します。サーバーが存在しない場合、そのサーバーのオブジェクトは利用可能なオブジェクトのリストに追加されません。サーバーの検証は時間のかかる処理であり、パフォーマンスに大きく影響します。

Insert Object ダイアログボックスまたは Paste Special ダイアログボックスから返された HMETAFILEPICT を解放するには、次のようにハンドル上の付随するメタファイルを削除します。

void FreeHmetafilepict(HMETAFILEPICT hmfp)
{
    if (hmfp != NULL)
    {
        LPMETAFILEPICT pmfp = GlobalLock(hmfp);

        DeleteMetaFile(pmfp->hMF);
        GlobalUnlock(hmfp);
        GlobalFree(hmfp);
    }
    else
    {
        // Handle null pointers here.
        exit(0);
    }
} 
メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

DWORD OleUIInsertObjectW(
    OLEUIINSERTOBJECTW* param0
);
[DllImport("oledlg.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint OleUIInsertObjectW(
    IntPtr param0   // OLEUIINSERTOBJECTW*
);
<DllImport("oledlg.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function OleUIInsertObjectW(
    param0 As IntPtr   ' OLEUIINSERTOBJECTW*
) As UInteger
End Function
' param0 : OLEUIINSERTOBJECTW*
Declare PtrSafe Function OleUIInsertObjectW Lib "oledlg" ( _
    ByVal param0 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

OleUIInsertObjectW = ctypes.windll.oledlg.OleUIInsertObjectW
OleUIInsertObjectW.restype = wintypes.DWORD
OleUIInsertObjectW.argtypes = [
    ctypes.c_void_p,  # param0 : OLEUIINSERTOBJECTW*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oledlg = windows.NewLazySystemDLL("oledlg.dll")
	procOleUIInsertObjectW = oledlg.NewProc("OleUIInsertObjectW")
)

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

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

typedef OleUIInsertObjectWNative = Uint32 Function(Pointer<Void>);
typedef OleUIInsertObjectWDart = int Function(Pointer<Void>);
final OleUIInsertObjectW = DynamicLibrary.open('oledlg.dll')
    .lookupFunction<OleUIInsertObjectWNative, OleUIInsertObjectWDart>('OleUIInsertObjectW');
// param0 : OLEUIINSERTOBJECTW* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleUIInsertObjectW(
  param0: Pointer   // OLEUIINSERTOBJECTW*
): DWORD; stdcall;
  external 'oledlg.dll' name 'OleUIInsertObjectW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OleUIInsertObjectW"
  c_OleUIInsertObjectW :: Ptr () -> IO Word32
-- param0 : OLEUIINSERTOBJECTW* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let oleuiinsertobjectw =
  foreign "OleUIInsertObjectW"
    ((ptr void) @-> returning uint32_t)
(* param0 : OLEUIINSERTOBJECTW* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oledlg (t "oledlg.dll"))
(cffi:use-foreign-library oledlg)

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

関連項目

文字セット違い
公式の関連項目
使用する型