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

RoOriginateErrorW

関数
HRESULTとワイド文字列メッセージでWinRTエラーを発生させる。
DLLapi-ms-win-core-winrt-error-l1-1-0.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// api-ms-win-core-winrt-error-l1-1-0.dll  (Unicode / -W)
#include <windows.h>

BOOL RoOriginateErrorW(
    HRESULT error,
    DWORD cchMax,
    LPCWSTR message   // optional
);

パラメーター

名前方向
errorHRESULTin
cchMaxDWORDin
messageLPCWSTRinoptional

戻り値の型: BOOL

各言語での呼び出し定義

// api-ms-win-core-winrt-error-l1-1-0.dll  (Unicode / -W)
#include <windows.h>

BOOL RoOriginateErrorW(
    HRESULT error,
    DWORD cchMax,
    LPCWSTR message   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-winrt-error-l1-1-0.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool RoOriginateErrorW(
    int error,   // HRESULT
    uint cchMax,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string message   // LPCWSTR optional
);
<DllImport("api-ms-win-core-winrt-error-l1-1-0.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RoOriginateErrorW(
    [error] As Integer,   ' HRESULT
    cchMax As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> message As String   ' LPCWSTR optional
) As Boolean
End Function
' error : HRESULT
' cchMax : DWORD
' message : LPCWSTR optional
Declare PtrSafe Function RoOriginateErrorW Lib "api-ms-win-core-winrt-error-l1-1-0" ( _
    ByVal error As Long, _
    ByVal cchMax As Long, _
    ByVal message 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

RoOriginateErrorW = ctypes.windll.LoadLibrary("api-ms-win-core-winrt-error-l1-1-0.dll").RoOriginateErrorW
RoOriginateErrorW.restype = wintypes.BOOL
RoOriginateErrorW.argtypes = [
    ctypes.c_int,  # error : HRESULT
    wintypes.DWORD,  # cchMax : DWORD
    wintypes.LPCWSTR,  # message : LPCWSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-winrt-error-l1-1-0.dll')
RoOriginateErrorW = Fiddle::Function.new(
  lib['RoOriginateErrorW'],
  [
    Fiddle::TYPE_INT,  # error : HRESULT
    -Fiddle::TYPE_INT,  # cchMax : DWORD
    Fiddle::TYPE_VOIDP,  # message : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "api-ms-win-core-winrt-error-l1-1-0")]
extern "system" {
    fn RoOriginateErrorW(
        error: i32,  // HRESULT
        cchMax: u32,  // DWORD
        message: *const u16  // LPCWSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-winrt-error-l1-1-0.dll", CharSet = CharSet.Unicode)]
public static extern bool RoOriginateErrorW(int error, uint cchMax, [MarshalAs(UnmanagedType.LPWStr)] string message);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-winrt-error-l1-1-0_RoOriginateErrorW' -Namespace Win32 -PassThru
# $api::RoOriginateErrorW(error, cchMax, message)
#uselib "api-ms-win-core-winrt-error-l1-1-0.dll"
#func global RoOriginateErrorW "RoOriginateErrorW" wptr, wptr, wptr
; RoOriginateErrorW error, cchMax, message   ; 戻り値は stat
; error : HRESULT -> "wptr"
; cchMax : DWORD -> "wptr"
; message : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-core-winrt-error-l1-1-0.dll"
#cfunc global RoOriginateErrorW "RoOriginateErrorW" int, int, wstr
; res = RoOriginateErrorW(error, cchMax, message)
; error : HRESULT -> "int"
; cchMax : DWORD -> "int"
; message : LPCWSTR optional -> "wstr"
; BOOL RoOriginateErrorW(HRESULT error, DWORD cchMax, LPCWSTR message)
#uselib "api-ms-win-core-winrt-error-l1-1-0.dll"
#cfunc global RoOriginateErrorW "RoOriginateErrorW" int, int, wstr
; res = RoOriginateErrorW(error, cchMax, message)
; error : HRESULT -> "int"
; cchMax : DWORD -> "int"
; message : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_winrt_error_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-core-winrt-error-l1-1-0.dll")
	procRoOriginateErrorW = api_ms_win_core_winrt_error_l1_1_0.NewProc("RoOriginateErrorW")
)

// error (HRESULT), cchMax (DWORD), message (LPCWSTR optional)
r1, _, err := procRoOriginateErrorW.Call(
	uintptr(error),
	uintptr(cchMax),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(message))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function RoOriginateErrorW(
  error: Integer;   // HRESULT
  cchMax: DWORD;   // DWORD
  message: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'api-ms-win-core-winrt-error-l1-1-0.dll' name 'RoOriginateErrorW';
result := DllCall("api-ms-win-core-winrt-error-l1-1-0\RoOriginateErrorW"
    , "Int", error   ; HRESULT
    , "UInt", cchMax   ; DWORD
    , "WStr", message   ; LPCWSTR optional
    , "Int")   ; return: BOOL
●RoOriginateErrorW(error, cchMax, message) = DLL("api-ms-win-core-winrt-error-l1-1-0.dll", "bool RoOriginateErrorW(int, dword, char*)")
# 呼び出し: RoOriginateErrorW(error, cchMax, message)
# error : HRESULT -> "int"
# cchMax : DWORD -> "dword"
# message : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。