Win32 API 日本語リファレンス
ホームUI.Accessibility › UiaGetErrorDescription

UiaGetErrorDescription

関数
直近のUIオートメーションエラーの説明文字列を取得する。
DLLUIAutomationCore.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// UIAutomationCore.dll
#include <windows.h>

BOOL UiaGetErrorDescription(
    LPWSTR* pDescription
);

パラメーター

名前方向説明
pDescriptionLPWSTR*inout直前のUIAutomation呼び出しで発生したエラーの説明文字列を受け取る出力ポインター。呼び出し側が解放する。

戻り値の型: BOOL

各言語での呼び出し定義

// UIAutomationCore.dll
#include <windows.h>

BOOL UiaGetErrorDescription(
    LPWSTR* pDescription
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("UIAutomationCore.dll", ExactSpelling = true)]
static extern bool UiaGetErrorDescription(
    IntPtr pDescription   // LPWSTR* in/out
);
<DllImport("UIAutomationCore.dll", ExactSpelling:=True)>
Public Shared Function UiaGetErrorDescription(
    pDescription As IntPtr   ' LPWSTR* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pDescription : LPWSTR* in/out
Declare PtrSafe Function UiaGetErrorDescription Lib "uiautomationcore" ( _
    ByVal pDescription As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UiaGetErrorDescription = ctypes.windll.uiautomationcore.UiaGetErrorDescription
UiaGetErrorDescription.restype = wintypes.BOOL
UiaGetErrorDescription.argtypes = [
    ctypes.c_void_p,  # pDescription : LPWSTR* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	uiautomationcore = windows.NewLazySystemDLL("UIAutomationCore.dll")
	procUiaGetErrorDescription = uiautomationcore.NewProc("UiaGetErrorDescription")
)

// pDescription (LPWSTR* in/out)
r1, _, err := procUiaGetErrorDescription.Call(
	uintptr(pDescription),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function UiaGetErrorDescription(
  pDescription: PPWideChar   // LPWSTR* in/out
): BOOL; stdcall;
  external 'UIAutomationCore.dll' name 'UiaGetErrorDescription';
result := DllCall("UIAutomationCore\UiaGetErrorDescription"
    , "Ptr", pDescription   ; LPWSTR* in/out
    , "Int")   ; return: BOOL
●UiaGetErrorDescription(pDescription) = DLL("UIAutomationCore.dll", "bool UiaGetErrorDescription(void*)")
# 呼び出し: UiaGetErrorDescription(pDescription)
# pDescription : LPWSTR* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "uiautomationcore" fn UiaGetErrorDescription(
    pDescription: [*c][*c]u16 // LPWSTR* in/out
) callconv(std.os.windows.WINAPI) i32;
proc UiaGetErrorDescription(
    pDescription: ptr WideCString  # LPWSTR* in/out
): int32 {.importc: "UiaGetErrorDescription", stdcall, dynlib: "UIAutomationCore.dll".}
pragma(lib, "uiautomationcore");
extern(Windows)
int UiaGetErrorDescription(
    wchar** pDescription   // LPWSTR* in/out
);
ccall((:UiaGetErrorDescription, "UIAutomationCore.dll"), stdcall, Int32,
      (Ptr{Ptr{UInt16}},),
      pDescription)
# pDescription : LPWSTR* in/out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t UiaGetErrorDescription(
    uint16_t** pDescription);
]]
local uiautomationcore = ffi.load("uiautomationcore")
-- uiautomationcore.UiaGetErrorDescription(pDescription)
-- pDescription : LPWSTR* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('UIAutomationCore.dll');
const UiaGetErrorDescription = lib.func('__stdcall', 'UiaGetErrorDescription', 'int32_t', ['void *']);
// UiaGetErrorDescription(pDescription)
// pDescription : LPWSTR* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("UIAutomationCore.dll", {
  UiaGetErrorDescription: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.UiaGetErrorDescription(pDescription)
// pDescription : LPWSTR* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UiaGetErrorDescription(
    uint16_t** pDescription);
C, "UIAutomationCore.dll");
// $ffi->UiaGetErrorDescription(pDescription);
// pDescription : LPWSTR* in/out
// 構造体/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 Uiautomationcore extends StdCallLibrary {
    Uiautomationcore INSTANCE = Native.load("uiautomationcore", Uiautomationcore.class);
    boolean UiaGetErrorDescription(
        PointerByReference pDescription   // LPWSTR* in/out
    );
}
@[Link("uiautomationcore")]
lib LibUIAutomationCore
  fun UiaGetErrorDescription = UiaGetErrorDescription(
    pDescription : UInt16**   # LPWSTR* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UiaGetErrorDescriptionNative = Int32 Function(Pointer<Pointer<Utf16>>);
typedef UiaGetErrorDescriptionDart = int Function(Pointer<Pointer<Utf16>>);
final UiaGetErrorDescription = DynamicLibrary.open('UIAutomationCore.dll')
    .lookupFunction<UiaGetErrorDescriptionNative, UiaGetErrorDescriptionDart>('UiaGetErrorDescription');
// pDescription : LPWSTR* in/out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UiaGetErrorDescription(
  pDescription: PPWideChar   // LPWSTR* in/out
): BOOL; stdcall;
  external 'UIAutomationCore.dll' name 'UiaGetErrorDescription';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UiaGetErrorDescription"
  c_UiaGetErrorDescription :: Ptr CWString -> IO CInt
-- pDescription : LPWSTR* in/out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let uiageterrordescription =
  foreign "UiaGetErrorDescription"
    ((ptr (ptr uint16_t)) @-> returning int32_t)
(* pDescription : LPWSTR* in/out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library uiautomationcore (t "UIAutomationCore.dll"))
(cffi:use-foreign-library uiautomationcore)

(cffi:defcfun ("UiaGetErrorDescription" uia-get-error-description :convention :stdcall) :int32
  (p-description :pointer))   ; LPWSTR* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UiaGetErrorDescription = Win32::API::More->new('UIAutomationCore',
    'BOOL UiaGetErrorDescription(LPVOID pDescription)');
# my $ret = $UiaGetErrorDescription->Call($pDescription);
# pDescription : LPWSTR* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。