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

OleUIConvertA

関数
オブジェクトのクラスを変換するダイアログを表示する。ANSI版。
DLLoledlg.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD OleUIConvertA(
    OLEUICONVERTA* param0
);

パラメーター

名前方向説明
param0OLEUICONVERTA*inオブジェクトの変換ダイアログを構成するOLEUICONVERTA構造体へのポインタ。

戻り値の型: DWORD

公式ドキュメント

標準の Convert ダイアログ ボックスを表示し、指定した単一オブジェクトの種類、または指定したオブジェクトのクラスに属するすべての OLE オブジェクトの種類を、ユーザーが変更できるようにします。(ANSI)

戻り値

標準の成功/エラー定義

戻り値 説明
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_CTERR_CLASSIDINVALID
clsid の値が無効でした。
OLEUI_CTERR_DVASPECTINVALID
dvAspect の値が無効でした。このメンバーはオブジェクトのアスペクトを指定します。
OLEUI_CTERR_CBFORMATINVALID
wFormat の値が無効でした。このメンバーはオブジェクトのデータ形式を指定します。
OLEUI_CTERR_STRINGINVALID
文字列値 (例: lpszUserTypelpszDefLabel) が無効でした。

解説(Remarks)

OleUIConvert は、レジストリを走査して Readable キーおよび ReadWritable キーのエントリを探すことで、Convert ダイアログ ボックスのリスト ボックスをオブジェクト クラスで埋めます。元のクラスの既定のファイル形式を Readable キーに含むすべてのクラスが Convert リストに追加され、元のクラスの既定のファイル形式を ReadWritable キーに含むすべてのクラスが Activate As リストに追加されます。Convert リストは Convert ラジオ ボタンが選択されているとき (既定の選択) にダイアログ ボックスのリスト ボックスに表示され、Activate As リストは Activate As が選択されているときに表示されます。

CF_CONVERTONLY が指定されていない場合にのみ、指定したクラスのすべてのオブジェクトの種類を変更できることに注意してください。

この関数を呼び出す convert コマンドは、OleUICanConvertOrActivateAsS_OK を返す場合にのみ、ユーザーが使用できるようにする必要があります。

メモ

oledlg.h ヘッダーは OLEUICONVERT をエイリアスとして定義しており、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  (ANSI / -A)
#include <windows.h>

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

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

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

var (
	oledlg = windows.NewLazySystemDLL("oledlg.dll")
	procOleUIConvertA = oledlg.NewProc("OleUIConvertA")
)

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

extern "oledlg" fn OleUIConvertA(
    param0: [*c]OLEUICONVERTA // OLEUICONVERTA*
) callconv(std.os.windows.WINAPI) u32;
proc OleUIConvertA(
    param0: ptr OLEUICONVERTA  # OLEUICONVERTA*
): uint32 {.importc: "OleUIConvertA", stdcall, dynlib: "oledlg.dll".}
pragma(lib, "oledlg");
extern(Windows)
uint OleUIConvertA(
    OLEUICONVERTA* param0   // OLEUICONVERTA*
);
ccall((:OleUIConvertA, "oledlg.dll"), stdcall, UInt32,
      (Ptr{OLEUICONVERTA},),
      param0)
# param0 : OLEUICONVERTA* -> Ptr{OLEUICONVERTA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t OleUIConvertA(
    void* param0);
]]
local oledlg = ffi.load("oledlg")
-- oledlg.OleUIConvertA(param0)
-- param0 : OLEUICONVERTA*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('oledlg.dll');
const OleUIConvertA = lib.func('__stdcall', 'OleUIConvertA', 'uint32_t', ['void *']);
// OleUIConvertA(param0)
// param0 : OLEUICONVERTA* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("oledlg.dll", {
  OleUIConvertA: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.OleUIConvertA(param0)
// param0 : OLEUICONVERTA* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t OleUIConvertA(
    void* param0);
C, "oledlg.dll");
// $ffi->OleUIConvertA(param0);
// param0 : OLEUICONVERTA*
// 構造体/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.ASCII_OPTIONS);
    int OleUIConvertA(
        Pointer param0   // OLEUICONVERTA*
    );
}
@[Link("oledlg")]
lib Liboledlg
  fun OleUIConvertA = OleUIConvertA(
    param0 : OLEUICONVERTA*   # OLEUICONVERTA*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("OleUIConvertA" ole-uiconvert-a :convention :stdcall) :uint32
  (param0 :pointer))   ; OLEUICONVERTA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleUIConvertA = Win32::API::More->new('oledlg',
    'DWORD OleUIConvertA(LPVOID param0)');
# my $ret = $OleUIConvertA->Call($param0);
# param0 : OLEUICONVERTA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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