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発生させるエラーを示すHRESULTコード。
cchMaxDWORDinmessageの最大文字数。0で全長を使用する。
messageLPCWSTRinoptionalエラーに付随する説明メッセージ文字列(Unicode)。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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 版の利用を推奨。
const std = @import("std");

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

typedef RoOriginateErrorWNative = Int32 Function(Int32, Uint32, Pointer<Utf16>);
typedef RoOriginateErrorWDart = int Function(int, int, Pointer<Utf16>);
final RoOriginateErrorW = DynamicLibrary.open('api-ms-win-core-winrt-error-l1-1-0.dll')
    .lookupFunction<RoOriginateErrorWNative, RoOriginateErrorWDart>('RoOriginateErrorW');
// error : HRESULT -> Int32
// cchMax : DWORD -> Uint32
// message : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RoOriginateErrorW"
  c_RoOriginateErrorW :: Int32 -> Word32 -> CWString -> IO CInt
-- error : HRESULT -> Int32
-- cchMax : DWORD -> Word32
-- message : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rooriginateerrorw =
  foreign "RoOriginateErrorW"
    (int32_t @-> uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* error : HRESULT -> int32_t *)
(* cchMax : DWORD -> uint32_t *)
(* message : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-core-winrt-error-l1-1-0 (t "api-ms-win-core-winrt-error-l1-1-0.dll"))
(cffi:use-foreign-library api-ms-win-core-winrt-error-l1-1-0)

(cffi:defcfun ("RoOriginateErrorW" ro-originate-error-w :convention :stdcall) :int32
  (error :int32)   ; HRESULT
  (cch-max :uint32)   ; DWORD
  (message (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RoOriginateErrorW = Win32::API::More->new('api-ms-win-core-winrt-error-l1-1-0',
    'BOOL RoOriginateErrorW(int error, DWORD cchMax, LPCWSTR message)');
# my $ret = $RoOriginateErrorW->Call($error, $cchMax, $message);
# error : HRESULT -> int
# cchMax : DWORD -> DWORD
# message : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。