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

OleUIBusyA

関数
サーバービジー時のダイアログを表示する。ANSI版。
DLLoledlg.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD OleUIBusyA(
    OLEUIBUSYA* param0
);

パラメーター

名前方向説明
param0OLEUIBUSYA*inサーバービジー通知ダイアログを構成するOLEUIBUSYA構造体へのポインタ。

戻り値の型: DWORD

公式ドキュメント

標準の Busy ダイアログ ボックスを呼び出し、ユーザーが同時実行を管理できるようにします。(ANSI)

戻り値

この関数は次の値を返します。

標準の成功/エラー定義

戻り値 説明
OLEUI_FALSE
不明な失敗 (未使用)。
OLEUI_SUCCESS
エラーなし。OLEUI_OK と同じです。
OLEUI_OK
ユーザーが OK ボタンを押しました。
OLEUI_CANCEL
ユーザーが キャンセル ボタンを押したため、呼び出し元は操作をキャンセルする必要があります。
OLEUI_BZ_SWITCHTOSELECTED
ユーザーが 切り替え を押しましたが、OleUIBusy はブロックしているアプリケーションへの切り替え方法を判別できませんでした。この場合、呼び出し元は可能であれば自身で競合の解決を試みるか、操作を再試行する必要があります。OleUIBusy は、ユーザーが 切り替え ボタンを押し、hTaskNULL で、かつ BZ_NOTRESPONDING フラグが設定されている場合にのみ OLEUI_BZ_SWITCHTOSELECTED を返します。
OLEUI_BZ_SWITCHTOSELECTED
ユーザーが 切り替え を押しましたが、OleUIBusy はブロックしているアプリケーションへの切り替え方法を判別できませんでした。この場合、呼び出し元は可能であれば自身で競合の解決を試みるか、操作を再試行する必要があります。OleUIBusy は、ユーザーが 切り替え ボタンを押し、hTaskNULL で、かつ BZ_NOTRESPONDING フラグが設定されている場合にのみ OLEUI_BZ_SWITCHTOSELECTED を返します。
OLEUI_BZ_SWITCHTOSELECTED
ユーザーが 切り替え を押しましたが、OleUIBusy はブロックしているアプリケーションへの切り替え方法を判別できませんでした。この場合、呼び出し元は可能であれば自身で競合の解決を試みるか、操作を再試行する必要があります。OleUIBusy は、ユーザーが 切り替え ボタンを押し、hTaskNULL で、かつ BZ_NOTRESPONDING フラグが設定されている場合にのみ OLEUI_BZ_SWITCHTOSELECTED を返します。
OLEUI_BZ_RETRYSELECTED
ユーザーが 再試行 ボタンを押したか、競合の解決を試みました (おそらくブロックしているアプリケーションに切り替えることによって)。この場合、呼び出し元は操作を再試行する必要があります。
OLEUI_BZ_CALLUNBLOCKED
操作のブロックが解除されたことがダイアログ ボックスに通知されました。

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

戻り値 説明
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_BZERR_HTASKINVALID
OLEUIBUSY 構造体の hTask メンバーで指定された hTask が無効です。

解説(Remarks)

標準の OLE サーバー Busy ダイアログ ボックスは、サーバー アプリケーションがメッセージを受信していないことをユーザーに通知します。次に、このダイアログ ボックスは操作のキャンセル、ブロックされているタスクへの切り替え、または待機の継続のいずれかを行うようユーザーに求めます。

メモ

oledlg.h ヘッダーは OLEUIBUSY をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコード ニュートラルなエイリアスの使用を、エンコード ニュートラルでないコードと混在させると、コンパイル エラーまたは実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、関数プロトタイプの規則 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 OleUIBusyA(
    OLEUIBUSYA* param0
);
[DllImport("oledlg.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint OleUIBusyA(
    IntPtr param0   // OLEUIBUSYA*
);
<DllImport("oledlg.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function OleUIBusyA(
    param0 As IntPtr   ' OLEUIBUSYA*
) As UInteger
End Function
' param0 : OLEUIBUSYA*
Declare PtrSafe Function OleUIBusyA 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

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

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

var (
	oledlg = windows.NewLazySystemDLL("oledlg.dll")
	procOleUIBusyA = oledlg.NewProc("OleUIBusyA")
)

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

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

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

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

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

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

関連項目

文字セット違い
使用する型