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

RouterLogEventExA

関数可変長引数
書式指定でルーターのイベントをログに記録する(ANSI版)。
DLLrtutils.dll文字セットANSI (-A)呼出規約cdecl

シグネチャ

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

void RouterLogEventExA(
    HANDLE hLogHandle,
    DWORD dwEventType,
    DWORD dwErrorCode,
    DWORD dwMessageId,
    LPCSTR ptszFormat,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

パラメーター

名前型方向説明
hLogHandleHANDLEinRouterLogRegisterで取得したログハンドル。出力先を指す。
dwEventTypeDWORDinイベントの種類(エラー/警告/情報等)を示す値を指定する。
dwErrorCodeDWORDin付随して記録するエラーコードを指定する。
dwMessageIdDWORDin記録するメッセージID(リソースID)を指定する。
ptszFormatLPCSTRin書式文字列(ANSI)。以降に可変引数が続く。

戻り値の型: void

各言語での呼び出し定義

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

void RouterLogEventExA(
    HANDLE hLogHandle,
    DWORD dwEventType,
    DWORD dwErrorCode,
    DWORD dwMessageId,
    LPCSTR ptszFormat,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
[DllImport("rtutils.dll", CharSet = CharSet.Ansi, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern void RouterLogEventExA(
    IntPtr hLogHandle,   // HANDLE
    uint dwEventType,   // DWORD
    uint dwErrorCode,   // DWORD
    uint dwMessageId,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string ptszFormat,   // LPCSTR
    __arglist
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<DllImport("rtutils.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Sub RouterLogEventExA(
    hLogHandle As IntPtr,   ' HANDLE
    dwEventType As UInteger,   ' DWORD
    dwErrorCode As UInteger,   ' DWORD
    dwMessageId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> ptszFormat As String   ' LPCSTR
)
End Sub
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
' hLogHandle : HANDLE
' dwEventType : DWORD
' dwErrorCode : DWORD
' dwMessageId : DWORD
' ptszFormat : LPCSTR
Declare PtrSafe Sub RouterLogEventExA Lib "rtutils" ( _
    ByVal hLogHandle As LongPtr, _
    ByVal dwEventType As Long, _
    ByVal dwErrorCode As Long, _
    ByVal dwMessageId As Long, _
    ByVal ptszFormat As String)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import ctypes
from ctypes import wintypes

RouterLogEventExA = ctypes.cdll.rtutils.RouterLogEventExA
RouterLogEventExA.restype = None
RouterLogEventExA.argtypes = [
    wintypes.HANDLE,  # hLogHandle : HANDLE
    wintypes.DWORD,  # dwEventType : DWORD
    wintypes.DWORD,  # dwErrorCode : DWORD
    wintypes.DWORD,  # dwMessageId : DWORD
    wintypes.LPCSTR,  # ptszFormat : LPCSTR
]
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtutils.dll')
RouterLogEventExA = Fiddle::Function.new(
  lib['RouterLogEventExA'],
  [
    Fiddle::TYPE_VOIDP,  # hLogHandle : HANDLE
    -Fiddle::TYPE_INT,  # dwEventType : DWORD
    -Fiddle::TYPE_INT,  # dwErrorCode : DWORD
    -Fiddle::TYPE_INT,  # dwMessageId : DWORD
    Fiddle::TYPE_VOIDP,  # ptszFormat : LPCSTR
  ],
  Fiddle::TYPE_VOID, Fiddle::Function::CDECL)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#[link(name = "rtutils")]
extern "C" {
    fn RouterLogEventExA(
        hLogHandle: *mut core::ffi::c_void,  // HANDLE
        dwEventType: u32,  // DWORD
        dwErrorCode: u32,  // DWORD
        dwMessageId: u32,  // DWORD
        ptszFormat: *const u8,  // LPCSTR
        ...
    );
}
// crates: windows-sys provides ready-made bindings for this API.
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
$sig = @"
[DllImport("rtutils.dll", CharSet = CharSet.Ansi, CallingConvention = CallingConvention.Cdecl)]
public static extern void RouterLogEventExA(IntPtr hLogHandle, uint dwEventType, uint dwErrorCode, uint dwMessageId, [MarshalAs(UnmanagedType.LPStr)] string ptszFormat);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtutils_RouterLogEventExA' -Namespace Win32 -PassThru
# $api::RouterLogEventExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "rtutils.dll"
#func global RouterLogEventExA "RouterLogEventExA" sptr, sptr, sptr, sptr, sptr
; RouterLogEventExA hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat
; hLogHandle : HANDLE -> "sptr"
; dwEventType : DWORD -> "sptr"
; dwErrorCode : DWORD -> "sptr"
; dwMessageId : DWORD -> "sptr"
; ptszFormat : LPCSTR -> "sptr"
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "rtutils.dll"
#func global RouterLogEventExA "RouterLogEventExA" sptr, int, int, int, str
; RouterLogEventExA hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat
; hLogHandle : HANDLE -> "sptr"
; dwEventType : DWORD -> "int"
; dwErrorCode : DWORD -> "int"
; dwMessageId : DWORD -> "int"
; ptszFormat : LPCSTR -> "str"
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
; void RouterLogEventExA(HANDLE hLogHandle, DWORD dwEventType, DWORD dwErrorCode, DWORD dwMessageId, LPCSTR ptszFormat)
#uselib "rtutils.dll"
#func global RouterLogEventExA "RouterLogEventExA" intptr, int, int, int, str
; RouterLogEventExA hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat
; hLogHandle : HANDLE -> "intptr"
; dwEventType : DWORD -> "int"
; dwErrorCode : DWORD -> "int"
; dwMessageId : DWORD -> "int"
; ptszFormat : LPCSTR -> "str"
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtutils = windows.NewLazySystemDLL("rtutils.dll")
	procRouterLogEventExA = rtutils.NewProc("RouterLogEventExA")
)

// hLogHandle (HANDLE), dwEventType (DWORD), dwErrorCode (DWORD), dwMessageId (DWORD), ptszFormat (LPCSTR)
r1, _, err := procRouterLogEventExA.Call(
	uintptr(hLogHandle),
	uintptr(dwEventType),
	uintptr(dwErrorCode),
	uintptr(dwMessageId),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ptszFormat))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
procedure RouterLogEventExA(
  hLogHandle: THandle;   // HANDLE
  dwEventType: DWORD;   // DWORD
  dwErrorCode: DWORD;   // DWORD
  dwMessageId: DWORD;   // DWORD
  ptszFormat: PAnsiChar   // LPCSTR
); cdecl; varargs;
  external 'rtutils.dll' name 'RouterLogEventExA';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
result := DllCall("rtutils\RouterLogEventExA"
    , "Ptr", hLogHandle   ; HANDLE
    , "UInt", dwEventType   ; DWORD
    , "UInt", dwErrorCode   ; DWORD
    , "UInt", dwMessageId   ; DWORD
    , "AStr", ptszFormat   ; LPCSTR
    , "Cdecl Int")   ; return: void
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
●RouterLogEventExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat) = DLL("rtutils.dll", "int RouterLogEventExA(void*, dword, dword, dword, char*)")
# 呼び出し: RouterLogEventExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat)
# hLogHandle : HANDLE -> "void*"
# dwEventType : DWORD -> "dword"
# dwErrorCode : DWORD -> "dword"
# dwMessageId : DWORD -> "dword"
# ptszFormat : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
# ※可変長引数。DLL()は固定引数のみ。追加引数は EXEC_PTR で渡してください。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const std = @import("std");

extern "rtutils" fn RouterLogEventExA(
    hLogHandle: ?*anyopaque, // HANDLE
    dwEventType: u32, // DWORD
    dwErrorCode: u32, // DWORD
    dwMessageId: u32, // DWORD
    ptszFormat: [*c]const u8, // LPCSTR
    ...
) callconv(.c) void;
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
proc RouterLogEventExA(
    hLogHandle: pointer,  # HANDLE
    dwEventType: uint32,  # DWORD
    dwErrorCode: uint32,  # DWORD
    dwMessageId: uint32,  # DWORD
    ptszFormat: cstring  # LPCSTR
) {.importc: "RouterLogEventExA", cdecl, varargs, dynlib: "rtutils.dll".}
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
pragma(lib, "rtutils");
extern(C)
void RouterLogEventExA(
    void* hLogHandle,   // HANDLE
    uint dwEventType,   // DWORD
    uint dwErrorCode,   // DWORD
    uint dwMessageId,   // DWORD
    const(char)* ptszFormat,   // LPCSTR
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
ccall((:RouterLogEventExA, "rtutils.dll"), Cvoid,
      (Ptr{Cvoid}, UInt32, UInt32, UInt32, Cstring),
      hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat)
# hLogHandle : HANDLE -> Ptr{Cvoid}
# dwEventType : DWORD -> UInt32
# dwErrorCode : DWORD -> UInt32
# dwMessageId : DWORD -> UInt32
# ptszFormat : LPCSTR -> Cstring
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
local ffi = require("ffi")
ffi.cdef[[
void RouterLogEventExA(
    void* hLogHandle,
    uint32_t dwEventType,
    uint32_t dwErrorCode,
    uint32_t dwMessageId,
    const char* ptszFormat,
    ...);
]]
local rtutils = ffi.load("rtutils")
-- rtutils.RouterLogEventExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat)
-- hLogHandle : HANDLE
-- dwEventType : DWORD
-- dwErrorCode : DWORD
-- dwMessageId : DWORD
-- ptszFormat : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const koffi = require('koffi');
const lib = koffi.load('rtutils.dll');
const RouterLogEventExA = lib.func('__cdecl', 'RouterLogEventExA', 'void', ['void *', 'uint32_t', 'uint32_t', 'uint32_t', 'str', '...']);
// RouterLogEventExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat)
// hLogHandle : HANDLE -> 'void *'
// dwEventType : DWORD -> 'uint32_t'
// dwErrorCode : DWORD -> 'uint32_t'
// dwMessageId : DWORD -> 'uint32_t'
// ptszFormat : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const lib = Deno.dlopen("rtutils.dll", {
  RouterLogEventExA: { parameters: ["pointer", "u32", "u32", "u32", "buffer"], result: "void" },
});
// lib.symbols.RouterLogEventExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat)
// hLogHandle : HANDLE -> "pointer"
// dwEventType : DWORD -> "u32"
// dwErrorCode : DWORD -> "u32"
// dwMessageId : DWORD -> "u32"
// ptszFormat : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<?php
$ffi = FFI::cdef(<<<C
void RouterLogEventExA(
    void* hLogHandle,
    uint32_t dwEventType,
    uint32_t dwErrorCode,
    uint32_t dwMessageId,
    const char* ptszFormat,
    ...);
C, "rtutils.dll");
// $ffi->RouterLogEventExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat);
// hLogHandle : HANDLE
// dwEventType : DWORD
// dwErrorCode : DWORD
// dwMessageId : DWORD
// ptszFormat : LPCSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
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 Library {
    Rtutils INSTANCE = Native.load("rtutils", Rtutils.class, W32APIOptions.ASCII_OPTIONS);
    void RouterLogEventExA(
        Pointer hLogHandle,   // HANDLE
        int dwEventType,   // DWORD
        int dwErrorCode,   // DWORD
        int dwMessageId,   // DWORD
        String ptszFormat,   // LPCSTR
        Object... args   // 可変長引数(printf形式)
    );
}
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
@[Link("rtutils")]
lib Librtutils
  fun RouterLogEventExA = RouterLogEventExA(
    hLogHandle : Void*,   # HANDLE
    dwEventType : UInt32,   # DWORD
    dwErrorCode : UInt32,   # DWORD
    dwMessageId : UInt32,   # DWORD
    ptszFormat : UInt8*,   # LPCSTR
    ...
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RouterLogEventExANative = Void Function(Pointer<Void>, Uint32, Uint32, Uint32, Pointer<Utf8>);
typedef RouterLogEventExADart = void Function(Pointer<Void>, int, int, int, Pointer<Utf8>);
final RouterLogEventExA = DynamicLibrary.open('rtutils.dll')
    .lookupFunction<RouterLogEventExANative, RouterLogEventExADart>('RouterLogEventExA');
// hLogHandle : HANDLE -> Pointer<Void>
// dwEventType : DWORD -> Uint32
// dwErrorCode : DWORD -> Uint32
// dwMessageId : DWORD -> Uint32
// ptszFormat : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
{$mode objfpc}{$H+}
procedure RouterLogEventExA(
  hLogHandle: THandle;   // HANDLE
  dwEventType: DWORD;   // DWORD
  dwErrorCode: DWORD;   // DWORD
  dwMessageId: DWORD;   // DWORD
  ptszFormat: PAnsiChar   // LPCSTR
); cdecl; varargs;
  external 'rtutils.dll' name 'RouterLogEventExA';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "RouterLogEventExA"
  c_RouterLogEventExA :: Ptr () -> Word32 -> Word32 -> Word32 -> CString -> IO ()
-- hLogHandle : HANDLE -> Ptr ()
-- dwEventType : DWORD -> Word32
-- dwErrorCode : DWORD -> Word32
-- dwMessageId : DWORD -> Word32
-- ptszFormat : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
open Ctypes
open Foreign

let routerlogeventexa =
  foreign "RouterLogEventExA"
    ((ptr void) @-> uint32_t @-> uint32_t @-> uint32_t @-> string @-> returning void)
(* hLogHandle : HANDLE -> (ptr void) *)
(* dwEventType : DWORD -> uint32_t *)
(* dwErrorCode : DWORD -> uint32_t *)
(* dwMessageId : DWORD -> uint32_t *)
(* ptszFormat : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(* ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
(cffi:define-foreign-library rtutils (t "rtutils.dll"))
(cffi:use-foreign-library rtutils)

(cffi:defcfun ("RouterLogEventExA" router-log-event-ex-a :convention :cdecl) :void
  (h-log-handle :pointer)   ; HANDLE
  (dw-event-type :uint32)   ; DWORD
  (dw-error-code :uint32)   ; DWORD
  (dw-message-id :uint32)   ; DWORD
  (ptsz-format :string)   ; LPCSTR
  &rest)   ; 可変長引数(printf形式)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
use Win32::API;
my $RouterLogEventExA = Win32::API::More->new('rtutils',
    'void RouterLogEventExA(HANDLE hLogHandle, DWORD dwEventType, DWORD dwErrorCode, DWORD dwMessageId, LPCSTR ptszFormat)');
# my $ret = $RouterLogEventExA->Call($hLogHandle, $dwEventType, $dwErrorCode, $dwMessageId, $ptszFormat);
# hLogHandle : HANDLE -> HANDLE
# dwEventType : DWORD -> DWORD
# dwErrorCode : DWORD -> DWORD
# dwMessageId : DWORD -> DWORD
# ptszFormat : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

関連項目

文字セット違い
類似 API