Win32 API 日本語リファレンス
ホームNetworkManagement.NetManagement › LogErrorW

LogErrorW

関数
エラーをイベントログに記録する(Unicode版)。
DLLrtutils.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// rtutils.dll  (Unicode / -W)
#include <windows.h>

void LogErrorW(
    DWORD dwMessageId,
    DWORD cNumberOfSubStrings,
    LPWSTR* plpwsSubStrings,
    DWORD dwErrorCode
);

パラメーター

名前方向説明
dwMessageIdDWORDinログに記録するメッセージID(リソースID)を指定する。
cNumberOfSubStringsDWORDinplpwsSubStrings配列内の置換文字列の数を指定する。
plpwsSubStringsLPWSTR*inメッセージ内のプレースホルダを埋める文字列配列(Unicode)。
dwErrorCodeDWORDin付随して記録するエラーコードを指定する。

戻り値の型: void

各言語での呼び出し定義

// rtutils.dll  (Unicode / -W)
#include <windows.h>

void LogErrorW(
    DWORD dwMessageId,
    DWORD cNumberOfSubStrings,
    LPWSTR* plpwsSubStrings,
    DWORD dwErrorCode
);
[DllImport("rtutils.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern void LogErrorW(
    uint dwMessageId,   // DWORD
    uint cNumberOfSubStrings,   // DWORD
    IntPtr plpwsSubStrings,   // LPWSTR*
    uint dwErrorCode   // DWORD
);
<DllImport("rtutils.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Sub LogErrorW(
    dwMessageId As UInteger,   ' DWORD
    cNumberOfSubStrings As UInteger,   ' DWORD
    plpwsSubStrings As IntPtr,   ' LPWSTR*
    dwErrorCode As UInteger   ' DWORD
)
End Sub
' dwMessageId : DWORD
' cNumberOfSubStrings : DWORD
' plpwsSubStrings : LPWSTR*
' dwErrorCode : DWORD
Declare PtrSafe Sub LogErrorW Lib "rtutils" ( _
    ByVal dwMessageId As Long, _
    ByVal cNumberOfSubStrings As Long, _
    ByVal plpwsSubStrings As LongPtr, _
    ByVal dwErrorCode 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

LogErrorW = ctypes.windll.rtutils.LogErrorW
LogErrorW.restype = None
LogErrorW.argtypes = [
    wintypes.DWORD,  # dwMessageId : DWORD
    wintypes.DWORD,  # cNumberOfSubStrings : DWORD
    ctypes.c_void_p,  # plpwsSubStrings : LPWSTR*
    wintypes.DWORD,  # dwErrorCode : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtutils.dll')
LogErrorW = Fiddle::Function.new(
  lib['LogErrorW'],
  [
    -Fiddle::TYPE_INT,  # dwMessageId : DWORD
    -Fiddle::TYPE_INT,  # cNumberOfSubStrings : DWORD
    Fiddle::TYPE_VOIDP,  # plpwsSubStrings : LPWSTR*
    -Fiddle::TYPE_INT,  # dwErrorCode : DWORD
  ],
  Fiddle::TYPE_VOID)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "rtutils")]
extern "system" {
    fn LogErrorW(
        dwMessageId: u32,  // DWORD
        cNumberOfSubStrings: u32,  // DWORD
        plpwsSubStrings: *mut *mut u16,  // LPWSTR*
        dwErrorCode: u32  // DWORD
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("rtutils.dll", CharSet = CharSet.Unicode)]
public static extern void LogErrorW(uint dwMessageId, uint cNumberOfSubStrings, IntPtr plpwsSubStrings, uint dwErrorCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtutils_LogErrorW' -Namespace Win32 -PassThru
# $api::LogErrorW(dwMessageId, cNumberOfSubStrings, plpwsSubStrings, dwErrorCode)
#uselib "rtutils.dll"
#func global LogErrorW "LogErrorW" wptr, wptr, wptr, wptr
; LogErrorW dwMessageId, cNumberOfSubStrings, varptr(plpwsSubStrings), dwErrorCode
; dwMessageId : DWORD -> "wptr"
; cNumberOfSubStrings : DWORD -> "wptr"
; plpwsSubStrings : LPWSTR* -> "wptr"
; dwErrorCode : DWORD -> "wptr"
出力引数:
#uselib "rtutils.dll"
#func global LogErrorW "LogErrorW" int, int, var, int
; LogErrorW dwMessageId, cNumberOfSubStrings, plpwsSubStrings, dwErrorCode
; dwMessageId : DWORD -> "int"
; cNumberOfSubStrings : DWORD -> "int"
; plpwsSubStrings : LPWSTR* -> "var"
; dwErrorCode : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; void LogErrorW(DWORD dwMessageId, DWORD cNumberOfSubStrings, LPWSTR* plpwsSubStrings, DWORD dwErrorCode)
#uselib "rtutils.dll"
#func global LogErrorW "LogErrorW" int, int, var, int
; LogErrorW dwMessageId, cNumberOfSubStrings, plpwsSubStrings, dwErrorCode
; dwMessageId : DWORD -> "int"
; cNumberOfSubStrings : DWORD -> "int"
; plpwsSubStrings : LPWSTR* -> "var"
; dwErrorCode : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtutils = windows.NewLazySystemDLL("rtutils.dll")
	procLogErrorW = rtutils.NewProc("LogErrorW")
)

// dwMessageId (DWORD), cNumberOfSubStrings (DWORD), plpwsSubStrings (LPWSTR*), dwErrorCode (DWORD)
r1, _, err := procLogErrorW.Call(
	uintptr(dwMessageId),
	uintptr(cNumberOfSubStrings),
	uintptr(plpwsSubStrings),
	uintptr(dwErrorCode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure LogErrorW(
  dwMessageId: DWORD;   // DWORD
  cNumberOfSubStrings: DWORD;   // DWORD
  plpwsSubStrings: PPWideChar;   // LPWSTR*
  dwErrorCode: DWORD   // DWORD
); stdcall;
  external 'rtutils.dll' name 'LogErrorW';
result := DllCall("rtutils\LogErrorW"
    , "UInt", dwMessageId   ; DWORD
    , "UInt", cNumberOfSubStrings   ; DWORD
    , "Ptr", plpwsSubStrings   ; LPWSTR*
    , "UInt", dwErrorCode   ; DWORD
    , "Int")   ; return: void
●LogErrorW(dwMessageId, cNumberOfSubStrings, plpwsSubStrings, dwErrorCode) = DLL("rtutils.dll", "int LogErrorW(dword, dword, void*, dword)")
# 呼び出し: LogErrorW(dwMessageId, cNumberOfSubStrings, plpwsSubStrings, dwErrorCode)
# dwMessageId : DWORD -> "dword"
# cNumberOfSubStrings : DWORD -> "dword"
# plpwsSubStrings : LPWSTR* -> "void*"
# dwErrorCode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

typedef LogErrorWNative = Void Function(Uint32, Uint32, Pointer<Pointer<Utf16>>, Uint32);
typedef LogErrorWDart = void Function(int, int, Pointer<Pointer<Utf16>>, int);
final LogErrorW = DynamicLibrary.open('rtutils.dll')
    .lookupFunction<LogErrorWNative, LogErrorWDart>('LogErrorW');
// dwMessageId : DWORD -> Uint32
// cNumberOfSubStrings : DWORD -> Uint32
// plpwsSubStrings : LPWSTR* -> Pointer<Pointer<Utf16>>
// dwErrorCode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure LogErrorW(
  dwMessageId: DWORD;   // DWORD
  cNumberOfSubStrings: DWORD;   // DWORD
  plpwsSubStrings: PPWideChar;   // LPWSTR*
  dwErrorCode: DWORD   // DWORD
); stdcall;
  external 'rtutils.dll' name 'LogErrorW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LogErrorW"
  c_LogErrorW :: Word32 -> Word32 -> Ptr CWString -> Word32 -> IO ()
-- dwMessageId : DWORD -> Word32
-- cNumberOfSubStrings : DWORD -> Word32
-- plpwsSubStrings : LPWSTR* -> Ptr CWString
-- dwErrorCode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let logerrorw =
  foreign "LogErrorW"
    (uint32_t @-> uint32_t @-> (ptr (ptr uint16_t)) @-> uint32_t @-> returning void)
(* dwMessageId : DWORD -> uint32_t *)
(* cNumberOfSubStrings : DWORD -> uint32_t *)
(* plpwsSubStrings : LPWSTR* -> (ptr (ptr uint16_t)) *)
(* dwErrorCode : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtutils (t "rtutils.dll"))
(cffi:use-foreign-library rtutils)

(cffi:defcfun ("LogErrorW" log-error-w :convention :stdcall) :void
  (dw-message-id :uint32)   ; DWORD
  (c-number-of-sub-strings :uint32)   ; DWORD
  (plpws-sub-strings :pointer)   ; LPWSTR*
  (dw-error-code :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LogErrorW = Win32::API::More->new('rtutils',
    'void LogErrorW(DWORD dwMessageId, DWORD cNumberOfSubStrings, LPVOID plpwsSubStrings, DWORD dwErrorCode)');
# my $ret = $LogErrorW->Call($dwMessageId, $cNumberOfSubStrings, $plpwsSubStrings, $dwErrorCode);
# dwMessageId : DWORD -> DWORD
# cNumberOfSubStrings : DWORD -> DWORD
# plpwsSubStrings : LPWSTR* -> LPVOID
# dwErrorCode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い