ホーム › NetworkManagement.NetManagement › RouterLogEventA

RouterLogEventA

関数

ルーターのイベントをログに記録する(ANSI版)。

DLLrtutils.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

void RouterLogEventA(
    HANDLE hLogHandle,
    DWORD dwEventType,
    DWORD dwMessageId,
    DWORD dwSubStringCount,
    LPSTR* plpszSubStringArray,   // optional
    DWORD dwErrorCode
);

パラメーター

名前	型	方向	説明
hLogHandle	HANDLE	in	RouterLogRegisterで取得したログハンドル。出力先を指す。
dwEventType	DWORD	in	イベントの種類(エラー/警告/情報等)を示す値を指定する。
dwMessageId	DWORD	in	記録するメッセージID(リソースID)を指定する。
dwSubStringCount	DWORD	in	plpszSubStringArray配列内の置換文字列の数を指定する。
plpszSubStringArray	LPSTR*	inoptional	メッセージ内のプレースホルダを埋める文字列配列(ANSI)。
dwErrorCode	DWORD	in	付随して記録するエラーコードを指定する。

戻り値の型: void

各言語での呼び出し定義

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

void RouterLogEventA(
    HANDLE hLogHandle,
    DWORD dwEventType,
    DWORD dwMessageId,
    DWORD dwSubStringCount,
    LPSTR* plpszSubStringArray,   // optional
    DWORD dwErrorCode
);

[DllImport("rtutils.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern void RouterLogEventA(
    IntPtr hLogHandle,   // HANDLE
    uint dwEventType,   // DWORD
    uint dwMessageId,   // DWORD
    uint dwSubStringCount,   // DWORD
    IntPtr plpszSubStringArray,   // LPSTR* optional
    uint dwErrorCode   // DWORD
);

<DllImport("rtutils.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Sub RouterLogEventA(
    hLogHandle As IntPtr,   ' HANDLE
    dwEventType As UInteger,   ' DWORD
    dwMessageId As UInteger,   ' DWORD
    dwSubStringCount As UInteger,   ' DWORD
    plpszSubStringArray As IntPtr,   ' LPSTR* optional
    dwErrorCode As UInteger   ' DWORD
)
End Sub

' hLogHandle : HANDLE
' dwEventType : DWORD
' dwMessageId : DWORD
' dwSubStringCount : DWORD
' plpszSubStringArray : LPSTR* optional
' dwErrorCode : DWORD
Declare PtrSafe Sub RouterLogEventA Lib "rtutils" ( _
    ByVal hLogHandle As LongPtr, _
    ByVal dwEventType As Long, _
    ByVal dwMessageId As Long, _
    ByVal dwSubStringCount As Long, _
    ByVal plpszSubStringArray As LongPtr, _
    ByVal dwErrorCode As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RouterLogEventA = ctypes.windll.rtutils.RouterLogEventA
RouterLogEventA.restype = None
RouterLogEventA.argtypes = [
    wintypes.HANDLE,  # hLogHandle : HANDLE
    wintypes.DWORD,  # dwEventType : DWORD
    wintypes.DWORD,  # dwMessageId : DWORD
    wintypes.DWORD,  # dwSubStringCount : DWORD
    ctypes.c_void_p,  # plpszSubStringArray : LPSTR* optional
    wintypes.DWORD,  # dwErrorCode : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtutils.dll')
RouterLogEventA = Fiddle::Function.new(
  lib['RouterLogEventA'],
  [
    Fiddle::TYPE_VOIDP,  # hLogHandle : HANDLE
    -Fiddle::TYPE_INT,  # dwEventType : DWORD
    -Fiddle::TYPE_INT,  # dwMessageId : DWORD
    -Fiddle::TYPE_INT,  # dwSubStringCount : DWORD
    Fiddle::TYPE_VOIDP,  # plpszSubStringArray : LPSTR* optional
    -Fiddle::TYPE_INT,  # dwErrorCode : DWORD
  ],
  Fiddle::TYPE_VOID)

#[link(name = "rtutils")]
extern "system" {
    fn RouterLogEventA(
        hLogHandle: *mut core::ffi::c_void,  // HANDLE
        dwEventType: u32,  // DWORD
        dwMessageId: u32,  // DWORD
        dwSubStringCount: u32,  // DWORD
        plpszSubStringArray: *mut *mut u8,  // LPSTR* optional
        dwErrorCode: u32  // DWORD
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("rtutils.dll", CharSet = CharSet.Ansi)]
public static extern void RouterLogEventA(IntPtr hLogHandle, uint dwEventType, uint dwMessageId, uint dwSubStringCount, IntPtr plpszSubStringArray, uint dwErrorCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtutils_RouterLogEventA' -Namespace Win32 -PassThru
# $api::RouterLogEventA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode)

#uselib "rtutils.dll"
#func global RouterLogEventA "RouterLogEventA" sptr, sptr, sptr, sptr, sptr, sptr
; RouterLogEventA hLogHandle, dwEventType, dwMessageId, dwSubStringCount, varptr(plpszSubStringArray), dwErrorCode
; hLogHandle : HANDLE -> "sptr"
; dwEventType : DWORD -> "sptr"
; dwMessageId : DWORD -> "sptr"
; dwSubStringCount : DWORD -> "sptr"
; plpszSubStringArray : LPSTR* optional -> "sptr"
; dwErrorCode : DWORD -> "sptr"

出力引数:

#uselib "rtutils.dll"
#func global RouterLogEventA "RouterLogEventA" sptr, int, int, int, var, int
; RouterLogEventA hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode
; hLogHandle : HANDLE -> "sptr"
; dwEventType : DWORD -> "int"
; dwMessageId : DWORD -> "int"
; dwSubStringCount : DWORD -> "int"
; plpszSubStringArray : LPSTR* optional -> "var"
; dwErrorCode : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "rtutils.dll"
#func global RouterLogEventA "RouterLogEventA" sptr, int, int, int, sptr, int
; RouterLogEventA hLogHandle, dwEventType, dwMessageId, dwSubStringCount, varptr(plpszSubStringArray), dwErrorCode
; hLogHandle : HANDLE -> "sptr"
; dwEventType : DWORD -> "int"
; dwMessageId : DWORD -> "int"
; dwSubStringCount : DWORD -> "int"
; plpszSubStringArray : LPSTR* optional -> "sptr"
; dwErrorCode : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; void RouterLogEventA(HANDLE hLogHandle, DWORD dwEventType, DWORD dwMessageId, DWORD dwSubStringCount, LPSTR* plpszSubStringArray, DWORD dwErrorCode)
#uselib "rtutils.dll"
#func global RouterLogEventA "RouterLogEventA" intptr, int, int, int, var, int
; RouterLogEventA hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode
; hLogHandle : HANDLE -> "intptr"
; dwEventType : DWORD -> "int"
; dwMessageId : DWORD -> "int"
; dwSubStringCount : DWORD -> "int"
; plpszSubStringArray : LPSTR* optional -> "var"
; dwErrorCode : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; void RouterLogEventA(HANDLE hLogHandle, DWORD dwEventType, DWORD dwMessageId, DWORD dwSubStringCount, LPSTR* plpszSubStringArray, DWORD dwErrorCode)
#uselib "rtutils.dll"
#func global RouterLogEventA "RouterLogEventA" intptr, int, int, int, intptr, int
; RouterLogEventA hLogHandle, dwEventType, dwMessageId, dwSubStringCount, varptr(plpszSubStringArray), dwErrorCode
; hLogHandle : HANDLE -> "intptr"
; dwEventType : DWORD -> "int"
; dwMessageId : DWORD -> "int"
; dwSubStringCount : DWORD -> "int"
; plpszSubStringArray : LPSTR* optional -> "intptr"
; dwErrorCode : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtutils = windows.NewLazySystemDLL("rtutils.dll")
	procRouterLogEventA = rtutils.NewProc("RouterLogEventA")
)

// hLogHandle (HANDLE), dwEventType (DWORD), dwMessageId (DWORD), dwSubStringCount (DWORD), plpszSubStringArray (LPSTR* optional), dwErrorCode (DWORD)
r1, _, err := procRouterLogEventA.Call(
	uintptr(hLogHandle),
	uintptr(dwEventType),
	uintptr(dwMessageId),
	uintptr(dwSubStringCount),
	uintptr(plpszSubStringArray),
	uintptr(dwErrorCode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void

procedure RouterLogEventA(
  hLogHandle: THandle;   // HANDLE
  dwEventType: DWORD;   // DWORD
  dwMessageId: DWORD;   // DWORD
  dwSubStringCount: DWORD;   // DWORD
  plpszSubStringArray: PPAnsiChar;   // LPSTR* optional
  dwErrorCode: DWORD   // DWORD
); stdcall;
  external 'rtutils.dll' name 'RouterLogEventA';

result := DllCall("rtutils\RouterLogEventA"
    , "Ptr", hLogHandle   ; HANDLE
    , "UInt", dwEventType   ; DWORD
    , "UInt", dwMessageId   ; DWORD
    , "UInt", dwSubStringCount   ; DWORD
    , "Ptr", plpszSubStringArray   ; LPSTR* optional
    , "UInt", dwErrorCode   ; DWORD
    , "Int")   ; return: void

●RouterLogEventA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode) = DLL("rtutils.dll", "int RouterLogEventA(void*, dword, dword, dword, void*, dword)")
# 呼び出し: RouterLogEventA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode)
# hLogHandle : HANDLE -> "void*"
# dwEventType : DWORD -> "dword"
# dwMessageId : DWORD -> "dword"
# dwSubStringCount : DWORD -> "dword"
# plpszSubStringArray : LPSTR* optional -> "void*"
# dwErrorCode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "rtutils" fn RouterLogEventA(
    hLogHandle: ?*anyopaque, // HANDLE
    dwEventType: u32, // DWORD
    dwMessageId: u32, // DWORD
    dwSubStringCount: u32, // DWORD
    plpszSubStringArray: [*c][*c]u8, // LPSTR* optional
    dwErrorCode: u32 // DWORD
) callconv(std.os.windows.WINAPI) void;

proc RouterLogEventA(
    hLogHandle: pointer,  # HANDLE
    dwEventType: uint32,  # DWORD
    dwMessageId: uint32,  # DWORD
    dwSubStringCount: uint32,  # DWORD
    plpszSubStringArray: ptr cstring,  # LPSTR* optional
    dwErrorCode: uint32  # DWORD
) {.importc: "RouterLogEventA", stdcall, dynlib: "rtutils.dll".}

pragma(lib, "rtutils");
extern(Windows)
void RouterLogEventA(
    void* hLogHandle,   // HANDLE
    uint dwEventType,   // DWORD
    uint dwMessageId,   // DWORD
    uint dwSubStringCount,   // DWORD
    char** plpszSubStringArray,   // LPSTR* optional
    uint dwErrorCode   // DWORD
);

ccall((:RouterLogEventA, "rtutils.dll"), stdcall, Cvoid,
      (Ptr{Cvoid}, UInt32, UInt32, UInt32, Ptr{Ptr{UInt8}}, UInt32),
      hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode)
# hLogHandle : HANDLE -> Ptr{Cvoid}
# dwEventType : DWORD -> UInt32
# dwMessageId : DWORD -> UInt32
# dwSubStringCount : DWORD -> UInt32
# plpszSubStringArray : LPSTR* optional -> Ptr{Ptr{UInt8}}
# dwErrorCode : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
void RouterLogEventA(
    void* hLogHandle,
    uint32_t dwEventType,
    uint32_t dwMessageId,
    uint32_t dwSubStringCount,
    char** plpszSubStringArray,
    uint32_t dwErrorCode);
]]
local rtutils = ffi.load("rtutils")
-- rtutils.RouterLogEventA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode)
-- hLogHandle : HANDLE
-- dwEventType : DWORD
-- dwMessageId : DWORD
-- dwSubStringCount : DWORD
-- plpszSubStringArray : LPSTR* optional
-- dwErrorCode : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('rtutils.dll');
const RouterLogEventA = lib.func('__stdcall', 'RouterLogEventA', 'void', ['void *', 'uint32_t', 'uint32_t', 'uint32_t', 'void *', 'uint32_t']);
// RouterLogEventA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode)
// hLogHandle : HANDLE -> 'void *'
// dwEventType : DWORD -> 'uint32_t'
// dwMessageId : DWORD -> 'uint32_t'
// dwSubStringCount : DWORD -> 'uint32_t'
// plpszSubStringArray : LPSTR* optional -> 'void *'
// dwErrorCode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("rtutils.dll", {
  RouterLogEventA: { parameters: ["pointer", "u32", "u32", "u32", "pointer", "u32"], result: "void" },
});
// lib.symbols.RouterLogEventA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode)
// hLogHandle : HANDLE -> "pointer"
// dwEventType : DWORD -> "u32"
// dwMessageId : DWORD -> "u32"
// dwSubStringCount : DWORD -> "u32"
// plpszSubStringArray : LPSTR* optional -> "pointer"
// dwErrorCode : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
void RouterLogEventA(
    void* hLogHandle,
    uint32_t dwEventType,
    uint32_t dwMessageId,
    uint32_t dwSubStringCount,
    char** plpszSubStringArray,
    uint32_t dwErrorCode);
C, "rtutils.dll");
// $ffi->RouterLogEventA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode);
// hLogHandle : HANDLE
// dwEventType : DWORD
// dwMessageId : DWORD
// dwSubStringCount : DWORD
// plpszSubStringArray : LPSTR* optional
// 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.ASCII_OPTIONS);
    void RouterLogEventA(
        Pointer hLogHandle,   // HANDLE
        int dwEventType,   // DWORD
        int dwMessageId,   // DWORD
        int dwSubStringCount,   // DWORD
        PointerByReference plpszSubStringArray,   // LPSTR* optional
        int dwErrorCode   // DWORD
    );
}

@[Link("rtutils")]
lib Librtutils
  fun RouterLogEventA = RouterLogEventA(
    hLogHandle : Void*,   # HANDLE
    dwEventType : UInt32,   # DWORD
    dwMessageId : UInt32,   # DWORD
    dwSubStringCount : UInt32,   # DWORD
    plpszSubStringArray : UInt8**,   # LPSTR* optional
    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 RouterLogEventANative = Void Function(Pointer<Void>, Uint32, Uint32, Uint32, Pointer<Pointer<Utf8>>, Uint32);
typedef RouterLogEventADart = void Function(Pointer<Void>, int, int, int, Pointer<Pointer<Utf8>>, int);
final RouterLogEventA = DynamicLibrary.open('rtutils.dll')
    .lookupFunction<RouterLogEventANative, RouterLogEventADart>('RouterLogEventA');
// hLogHandle : HANDLE -> Pointer<Void>
// dwEventType : DWORD -> Uint32
// dwMessageId : DWORD -> Uint32
// dwSubStringCount : DWORD -> Uint32
// plpszSubStringArray : LPSTR* optional -> Pointer<Pointer<Utf8>>
// dwErrorCode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
procedure RouterLogEventA(
  hLogHandle: THandle;   // HANDLE
  dwEventType: DWORD;   // DWORD
  dwMessageId: DWORD;   // DWORD
  dwSubStringCount: DWORD;   // DWORD
  plpszSubStringArray: PPAnsiChar;   // LPSTR* optional
  dwErrorCode: DWORD   // DWORD
); stdcall;
  external 'rtutils.dll' name 'RouterLogEventA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RouterLogEventA"
  c_RouterLogEventA :: Ptr () -> Word32 -> Word32 -> Word32 -> Ptr CString -> Word32 -> IO ()
-- hLogHandle : HANDLE -> Ptr ()
-- dwEventType : DWORD -> Word32
-- dwMessageId : DWORD -> Word32
-- dwSubStringCount : DWORD -> Word32
-- plpszSubStringArray : LPSTR* optional -> Ptr CString
-- dwErrorCode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let routerlogeventa =
  foreign "RouterLogEventA"
    ((ptr void) @-> uint32_t @-> uint32_t @-> uint32_t @-> (ptr string) @-> uint32_t @-> returning void)
(* hLogHandle : HANDLE -> (ptr void) *)
(* dwEventType : DWORD -> uint32_t *)
(* dwMessageId : DWORD -> uint32_t *)
(* dwSubStringCount : DWORD -> uint32_t *)
(* plpszSubStringArray : LPSTR* optional -> (ptr string) *)
(* 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 ("RouterLogEventA" router-log-event-a :convention :stdcall) :void
  (h-log-handle :pointer)   ; HANDLE
  (dw-event-type :uint32)   ; DWORD
  (dw-message-id :uint32)   ; DWORD
  (dw-sub-string-count :uint32)   ; DWORD
  (plpsz-sub-string-array :pointer)   ; LPSTR* optional
  (dw-error-code :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $RouterLogEventA = Win32::API::More->new('rtutils',
    'void RouterLogEventA(HANDLE hLogHandle, DWORD dwEventType, DWORD dwMessageId, DWORD dwSubStringCount, LPVOID plpszSubStringArray, DWORD dwErrorCode)');
# my $ret = $RouterLogEventA->Call($hLogHandle, $dwEventType, $dwMessageId, $dwSubStringCount, $plpszSubStringArray, $dwErrorCode);
# hLogHandle : HANDLE -> HANDLE
# dwEventType : DWORD -> DWORD
# dwMessageId : DWORD -> DWORD
# dwSubStringCount : DWORD -> DWORD
# plpszSubStringArray : LPSTR* optional -> LPVOID
# dwErrorCode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

RouterLogEventA

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目