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

RouterLogEventValistExA

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

シグネチャ

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

void RouterLogEventValistExA(
    HANDLE hLogHandle,
    DWORD dwEventType,
    DWORD dwErrorCode,
    DWORD dwMessageId,
    LPCSTR ptszFormat,
    CHAR* arglist
);

パラメーター

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

戻り値の型: void

各言語での呼び出し定義

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

void RouterLogEventValistExA(
    HANDLE hLogHandle,
    DWORD dwEventType,
    DWORD dwErrorCode,
    DWORD dwMessageId,
    LPCSTR ptszFormat,
    CHAR* arglist
);
[DllImport("rtutils.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern void RouterLogEventValistExA(
    IntPtr hLogHandle,   // HANDLE
    uint dwEventType,   // DWORD
    uint dwErrorCode,   // DWORD
    uint dwMessageId,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string ptszFormat,   // LPCSTR
    IntPtr arglist   // CHAR* in/out
);
<DllImport("rtutils.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Sub RouterLogEventValistExA(
    hLogHandle As IntPtr,   ' HANDLE
    dwEventType As UInteger,   ' DWORD
    dwErrorCode As UInteger,   ' DWORD
    dwMessageId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> ptszFormat As String,   ' LPCSTR
    arglist As IntPtr   ' CHAR* in/out
)
End Sub
' hLogHandle : HANDLE
' dwEventType : DWORD
' dwErrorCode : DWORD
' dwMessageId : DWORD
' ptszFormat : LPCSTR
' arglist : CHAR* in/out
Declare PtrSafe Sub RouterLogEventValistExA Lib "rtutils" ( _
    ByVal hLogHandle As LongPtr, _
    ByVal dwEventType As Long, _
    ByVal dwErrorCode As Long, _
    ByVal dwMessageId As Long, _
    ByVal ptszFormat As String, _
    ByVal arglist As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RouterLogEventValistExA = ctypes.windll.rtutils.RouterLogEventValistExA
RouterLogEventValistExA.restype = None
RouterLogEventValistExA.argtypes = [
    wintypes.HANDLE,  # hLogHandle : HANDLE
    wintypes.DWORD,  # dwEventType : DWORD
    wintypes.DWORD,  # dwErrorCode : DWORD
    wintypes.DWORD,  # dwMessageId : DWORD
    wintypes.LPCSTR,  # ptszFormat : LPCSTR
    ctypes.POINTER(ctypes.c_byte),  # arglist : CHAR* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtutils = windows.NewLazySystemDLL("rtutils.dll")
	procRouterLogEventValistExA = rtutils.NewProc("RouterLogEventValistExA")
)

// hLogHandle (HANDLE), dwEventType (DWORD), dwErrorCode (DWORD), dwMessageId (DWORD), ptszFormat (LPCSTR), arglist (CHAR* in/out)
r1, _, err := procRouterLogEventValistExA.Call(
	uintptr(hLogHandle),
	uintptr(dwEventType),
	uintptr(dwErrorCode),
	uintptr(dwMessageId),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ptszFormat))),
	uintptr(arglist),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure RouterLogEventValistExA(
  hLogHandle: THandle;   // HANDLE
  dwEventType: DWORD;   // DWORD
  dwErrorCode: DWORD;   // DWORD
  dwMessageId: DWORD;   // DWORD
  ptszFormat: PAnsiChar;   // LPCSTR
  arglist: Pointer   // CHAR* in/out
); stdcall;
  external 'rtutils.dll' name 'RouterLogEventValistExA';
result := DllCall("rtutils\RouterLogEventValistExA"
    , "Ptr", hLogHandle   ; HANDLE
    , "UInt", dwEventType   ; DWORD
    , "UInt", dwErrorCode   ; DWORD
    , "UInt", dwMessageId   ; DWORD
    , "AStr", ptszFormat   ; LPCSTR
    , "Ptr", arglist   ; CHAR* in/out
    , "Int")   ; return: void
●RouterLogEventValistExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat, arglist) = DLL("rtutils.dll", "int RouterLogEventValistExA(void*, dword, dword, dword, char*, void*)")
# 呼び出し: RouterLogEventValistExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat, arglist)
# hLogHandle : HANDLE -> "void*"
# dwEventType : DWORD -> "dword"
# dwErrorCode : DWORD -> "dword"
# dwMessageId : DWORD -> "dword"
# ptszFormat : LPCSTR -> "char*"
# arglist : CHAR* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "rtutils" fn RouterLogEventValistExA(
    hLogHandle: ?*anyopaque, // HANDLE
    dwEventType: u32, // DWORD
    dwErrorCode: u32, // DWORD
    dwMessageId: u32, // DWORD
    ptszFormat: [*c]const u8, // LPCSTR
    arglist: [*c]i8 // CHAR* in/out
) callconv(std.os.windows.WINAPI) void;
proc RouterLogEventValistExA(
    hLogHandle: pointer,  # HANDLE
    dwEventType: uint32,  # DWORD
    dwErrorCode: uint32,  # DWORD
    dwMessageId: uint32,  # DWORD
    ptszFormat: cstring,  # LPCSTR
    arglist: ptr int8  # CHAR* in/out
) {.importc: "RouterLogEventValistExA", stdcall, dynlib: "rtutils.dll".}
pragma(lib, "rtutils");
extern(Windows)
void RouterLogEventValistExA(
    void* hLogHandle,   // HANDLE
    uint dwEventType,   // DWORD
    uint dwErrorCode,   // DWORD
    uint dwMessageId,   // DWORD
    const(char)* ptszFormat,   // LPCSTR
    byte* arglist   // CHAR* in/out
);
ccall((:RouterLogEventValistExA, "rtutils.dll"), stdcall, Cvoid,
      (Ptr{Cvoid}, UInt32, UInt32, UInt32, Cstring, Ptr{Int8}),
      hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat, arglist)
# hLogHandle : HANDLE -> Ptr{Cvoid}
# dwEventType : DWORD -> UInt32
# dwErrorCode : DWORD -> UInt32
# dwMessageId : DWORD -> UInt32
# ptszFormat : LPCSTR -> Cstring
# arglist : CHAR* in/out -> Ptr{Int8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void RouterLogEventValistExA(
    void* hLogHandle,
    uint32_t dwEventType,
    uint32_t dwErrorCode,
    uint32_t dwMessageId,
    const char* ptszFormat,
    int8_t* arglist);
]]
local rtutils = ffi.load("rtutils")
-- rtutils.RouterLogEventValistExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat, arglist)
-- hLogHandle : HANDLE
-- dwEventType : DWORD
-- dwErrorCode : DWORD
-- dwMessageId : DWORD
-- ptszFormat : LPCSTR
-- arglist : CHAR* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('rtutils.dll');
const RouterLogEventValistExA = lib.func('__stdcall', 'RouterLogEventValistExA', 'void', ['void *', 'uint32_t', 'uint32_t', 'uint32_t', 'str', 'int8_t *']);
// RouterLogEventValistExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat, arglist)
// hLogHandle : HANDLE -> 'void *'
// dwEventType : DWORD -> 'uint32_t'
// dwErrorCode : DWORD -> 'uint32_t'
// dwMessageId : DWORD -> 'uint32_t'
// ptszFormat : LPCSTR -> 'str'
// arglist : CHAR* in/out -> 'int8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("rtutils.dll", {
  RouterLogEventValistExA: { parameters: ["pointer", "u32", "u32", "u32", "buffer", "pointer"], result: "void" },
});
// lib.symbols.RouterLogEventValistExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat, arglist)
// hLogHandle : HANDLE -> "pointer"
// dwEventType : DWORD -> "u32"
// dwErrorCode : DWORD -> "u32"
// dwMessageId : DWORD -> "u32"
// ptszFormat : LPCSTR -> "buffer"
// arglist : CHAR* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void RouterLogEventValistExA(
    void* hLogHandle,
    uint32_t dwEventType,
    uint32_t dwErrorCode,
    uint32_t dwMessageId,
    const char* ptszFormat,
    int8_t* arglist);
C, "rtutils.dll");
// $ffi->RouterLogEventValistExA(hLogHandle, dwEventType, dwErrorCode, dwMessageId, ptszFormat, arglist);
// hLogHandle : HANDLE
// dwEventType : DWORD
// dwErrorCode : DWORD
// dwMessageId : DWORD
// ptszFormat : LPCSTR
// arglist : CHAR* in/out
// 構造体/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 RouterLogEventValistExA(
        Pointer hLogHandle,   // HANDLE
        int dwEventType,   // DWORD
        int dwErrorCode,   // DWORD
        int dwMessageId,   // DWORD
        String ptszFormat,   // LPCSTR
        byte[] arglist   // CHAR* in/out
    );
}
@[Link("rtutils")]
lib Librtutils
  fun RouterLogEventValistExA = RouterLogEventValistExA(
    hLogHandle : Void*,   # HANDLE
    dwEventType : UInt32,   # DWORD
    dwErrorCode : UInt32,   # DWORD
    dwMessageId : UInt32,   # DWORD
    ptszFormat : UInt8*,   # LPCSTR
    arglist : Int8*   # CHAR* in/out
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RouterLogEventValistExANative = Void Function(Pointer<Void>, Uint32, Uint32, Uint32, Pointer<Utf8>, Pointer<Int8>);
typedef RouterLogEventValistExADart = void Function(Pointer<Void>, int, int, int, Pointer<Utf8>, Pointer<Int8>);
final RouterLogEventValistExA = DynamicLibrary.open('rtutils.dll')
    .lookupFunction<RouterLogEventValistExANative, RouterLogEventValistExADart>('RouterLogEventValistExA');
// hLogHandle : HANDLE -> Pointer<Void>
// dwEventType : DWORD -> Uint32
// dwErrorCode : DWORD -> Uint32
// dwMessageId : DWORD -> Uint32
// ptszFormat : LPCSTR -> Pointer<Utf8>
// arglist : CHAR* in/out -> Pointer<Int8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure RouterLogEventValistExA(
  hLogHandle: THandle;   // HANDLE
  dwEventType: DWORD;   // DWORD
  dwErrorCode: DWORD;   // DWORD
  dwMessageId: DWORD;   // DWORD
  ptszFormat: PAnsiChar;   // LPCSTR
  arglist: Pointer   // CHAR* in/out
); stdcall;
  external 'rtutils.dll' name 'RouterLogEventValistExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RouterLogEventValistExA"
  c_RouterLogEventValistExA :: Ptr () -> Word32 -> Word32 -> Word32 -> CString -> Ptr Int8 -> IO ()
-- hLogHandle : HANDLE -> Ptr ()
-- dwEventType : DWORD -> Word32
-- dwErrorCode : DWORD -> Word32
-- dwMessageId : DWORD -> Word32
-- ptszFormat : LPCSTR -> CString
-- arglist : CHAR* in/out -> Ptr Int8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let routerlogeventvalistexa =
  foreign "RouterLogEventValistExA"
    ((ptr void) @-> uint32_t @-> uint32_t @-> uint32_t @-> string @-> (ptr int8_t) @-> returning void)
(* hLogHandle : HANDLE -> (ptr void) *)
(* dwEventType : DWORD -> uint32_t *)
(* dwErrorCode : DWORD -> uint32_t *)
(* dwMessageId : DWORD -> uint32_t *)
(* ptszFormat : LPCSTR -> string *)
(* arglist : CHAR* in/out -> (ptr int8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtutils (t "rtutils.dll"))
(cffi:use-foreign-library rtutils)

(cffi:defcfun ("RouterLogEventValistExA" router-log-event-valist-ex-a :convention :stdcall) :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
  (arglist :pointer))   ; CHAR* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RouterLogEventValistExA = Win32::API::More->new('rtutils',
    'void RouterLogEventValistExA(HANDLE hLogHandle, DWORD dwEventType, DWORD dwErrorCode, DWORD dwMessageId, LPCSTR ptszFormat, LPVOID arglist)');
# my $ret = $RouterLogEventValistExA->Call($hLogHandle, $dwEventType, $dwErrorCode, $dwMessageId, $ptszFormat, $arglist);
# hLogHandle : HANDLE -> HANDLE
# dwEventType : DWORD -> DWORD
# dwErrorCode : DWORD -> DWORD
# dwMessageId : DWORD -> DWORD
# ptszFormat : LPCSTR -> LPCSTR
# arglist : CHAR* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い