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

RouterLogEventStringA

関数
エラー文字列付きでルーターのイベントをログに記録する(ANSI版)。
DLLrtutils.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

void RouterLogEventStringA(
    HANDLE hLogHandle,
    DWORD dwEventType,
    DWORD dwMessageId,
    DWORD dwSubStringCount,
    LPSTR* plpszSubStringArray,
    DWORD dwErrorCode,
    DWORD dwErrorIndex
);

パラメーター

名前方向
hLogHandleHANDLEin
dwEventTypeDWORDin
dwMessageIdDWORDin
dwSubStringCountDWORDin
plpszSubStringArrayLPSTR*in
dwErrorCodeDWORDin
dwErrorIndexDWORDin

戻り値の型: void

各言語での呼び出し定義

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

void RouterLogEventStringA(
    HANDLE hLogHandle,
    DWORD dwEventType,
    DWORD dwMessageId,
    DWORD dwSubStringCount,
    LPSTR* plpszSubStringArray,
    DWORD dwErrorCode,
    DWORD dwErrorIndex
);
[DllImport("rtutils.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern void RouterLogEventStringA(
    IntPtr hLogHandle,   // HANDLE
    uint dwEventType,   // DWORD
    uint dwMessageId,   // DWORD
    uint dwSubStringCount,   // DWORD
    IntPtr plpszSubStringArray,   // LPSTR*
    uint dwErrorCode,   // DWORD
    uint dwErrorIndex   // DWORD
);
<DllImport("rtutils.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Sub RouterLogEventStringA(
    hLogHandle As IntPtr,   ' HANDLE
    dwEventType As UInteger,   ' DWORD
    dwMessageId As UInteger,   ' DWORD
    dwSubStringCount As UInteger,   ' DWORD
    plpszSubStringArray As IntPtr,   ' LPSTR*
    dwErrorCode As UInteger,   ' DWORD
    dwErrorIndex As UInteger   ' DWORD
)
End Sub
' hLogHandle : HANDLE
' dwEventType : DWORD
' dwMessageId : DWORD
' dwSubStringCount : DWORD
' plpszSubStringArray : LPSTR*
' dwErrorCode : DWORD
' dwErrorIndex : DWORD
Declare PtrSafe Sub RouterLogEventStringA 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, _
    ByVal dwErrorIndex As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RouterLogEventStringA = ctypes.windll.rtutils.RouterLogEventStringA
RouterLogEventStringA.restype = None
RouterLogEventStringA.argtypes = [
    wintypes.HANDLE,  # hLogHandle : HANDLE
    wintypes.DWORD,  # dwEventType : DWORD
    wintypes.DWORD,  # dwMessageId : DWORD
    wintypes.DWORD,  # dwSubStringCount : DWORD
    ctypes.c_void_p,  # plpszSubStringArray : LPSTR*
    wintypes.DWORD,  # dwErrorCode : DWORD
    wintypes.DWORD,  # dwErrorIndex : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtutils.dll')
RouterLogEventStringA = Fiddle::Function.new(
  lib['RouterLogEventStringA'],
  [
    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*
    -Fiddle::TYPE_INT,  # dwErrorCode : DWORD
    -Fiddle::TYPE_INT,  # dwErrorIndex : DWORD
  ],
  Fiddle::TYPE_VOID)
#[link(name = "rtutils")]
extern "system" {
    fn RouterLogEventStringA(
        hLogHandle: *mut core::ffi::c_void,  // HANDLE
        dwEventType: u32,  // DWORD
        dwMessageId: u32,  // DWORD
        dwSubStringCount: u32,  // DWORD
        plpszSubStringArray: *mut *mut u8,  // LPSTR*
        dwErrorCode: u32,  // DWORD
        dwErrorIndex: u32  // DWORD
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("rtutils.dll", CharSet = CharSet.Ansi)]
public static extern void RouterLogEventStringA(IntPtr hLogHandle, uint dwEventType, uint dwMessageId, uint dwSubStringCount, IntPtr plpszSubStringArray, uint dwErrorCode, uint dwErrorIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtutils_RouterLogEventStringA' -Namespace Win32 -PassThru
# $api::RouterLogEventStringA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode, dwErrorIndex)
#uselib "rtutils.dll"
#func global RouterLogEventStringA "RouterLogEventStringA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; RouterLogEventStringA hLogHandle, dwEventType, dwMessageId, dwSubStringCount, varptr(plpszSubStringArray), dwErrorCode, dwErrorIndex
; hLogHandle : HANDLE -> "sptr"
; dwEventType : DWORD -> "sptr"
; dwMessageId : DWORD -> "sptr"
; dwSubStringCount : DWORD -> "sptr"
; plpszSubStringArray : LPSTR* -> "sptr"
; dwErrorCode : DWORD -> "sptr"
; dwErrorIndex : DWORD -> "sptr"
出力引数:
#uselib "rtutils.dll"
#func global RouterLogEventStringA "RouterLogEventStringA" sptr, int, int, int, var, int, int
; RouterLogEventStringA hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode, dwErrorIndex
; hLogHandle : HANDLE -> "sptr"
; dwEventType : DWORD -> "int"
; dwMessageId : DWORD -> "int"
; dwSubStringCount : DWORD -> "int"
; plpszSubStringArray : LPSTR* -> "var"
; dwErrorCode : DWORD -> "int"
; dwErrorIndex : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; void RouterLogEventStringA(HANDLE hLogHandle, DWORD dwEventType, DWORD dwMessageId, DWORD dwSubStringCount, LPSTR* plpszSubStringArray, DWORD dwErrorCode, DWORD dwErrorIndex)
#uselib "rtutils.dll"
#func global RouterLogEventStringA "RouterLogEventStringA" intptr, int, int, int, var, int, int
; RouterLogEventStringA hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode, dwErrorIndex
; hLogHandle : HANDLE -> "intptr"
; dwEventType : DWORD -> "int"
; dwMessageId : DWORD -> "int"
; dwSubStringCount : DWORD -> "int"
; plpszSubStringArray : LPSTR* -> "var"
; dwErrorCode : DWORD -> "int"
; dwErrorIndex : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtutils = windows.NewLazySystemDLL("rtutils.dll")
	procRouterLogEventStringA = rtutils.NewProc("RouterLogEventStringA")
)

// hLogHandle (HANDLE), dwEventType (DWORD), dwMessageId (DWORD), dwSubStringCount (DWORD), plpszSubStringArray (LPSTR*), dwErrorCode (DWORD), dwErrorIndex (DWORD)
r1, _, err := procRouterLogEventStringA.Call(
	uintptr(hLogHandle),
	uintptr(dwEventType),
	uintptr(dwMessageId),
	uintptr(dwSubStringCount),
	uintptr(plpszSubStringArray),
	uintptr(dwErrorCode),
	uintptr(dwErrorIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure RouterLogEventStringA(
  hLogHandle: THandle;   // HANDLE
  dwEventType: DWORD;   // DWORD
  dwMessageId: DWORD;   // DWORD
  dwSubStringCount: DWORD;   // DWORD
  plpszSubStringArray: PPAnsiChar;   // LPSTR*
  dwErrorCode: DWORD;   // DWORD
  dwErrorIndex: DWORD   // DWORD
); stdcall;
  external 'rtutils.dll' name 'RouterLogEventStringA';
result := DllCall("rtutils\RouterLogEventStringA"
    , "Ptr", hLogHandle   ; HANDLE
    , "UInt", dwEventType   ; DWORD
    , "UInt", dwMessageId   ; DWORD
    , "UInt", dwSubStringCount   ; DWORD
    , "Ptr", plpszSubStringArray   ; LPSTR*
    , "UInt", dwErrorCode   ; DWORD
    , "UInt", dwErrorIndex   ; DWORD
    , "Int")   ; return: void
●RouterLogEventStringA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode, dwErrorIndex) = DLL("rtutils.dll", "int RouterLogEventStringA(void*, dword, dword, dword, void*, dword, dword)")
# 呼び出し: RouterLogEventStringA(hLogHandle, dwEventType, dwMessageId, dwSubStringCount, plpszSubStringArray, dwErrorCode, dwErrorIndex)
# hLogHandle : HANDLE -> "void*"
# dwEventType : DWORD -> "dword"
# dwMessageId : DWORD -> "dword"
# dwSubStringCount : DWORD -> "dword"
# plpszSubStringArray : LPSTR* -> "void*"
# dwErrorCode : DWORD -> "dword"
# dwErrorIndex : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。