Win32 API 日本語リファレンス
ホームDevices.DeviceAndDriverInstallation › SetupWriteTextLogError

SetupWriteTextLogError

関数可変長引数
エラーコードを伴うエラーメッセージをテキストログに書き込む。
DLLSETUPAPI.dll呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

// SETUPAPI.dll
#include <windows.h>

void SetupWriteTextLogError(
    ULONGLONG LogToken,
    DWORD Category,
    DWORD LogFlags,
    DWORD Error,
    LPCSTR MessageStr,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

パラメーター

名前方向説明
LogTokenULONGLONGin書き込み先を識別するログトークン値。
CategoryDWORDinログカテゴリを示すTXTLOG_*値。
LogFlagsDWORDin重大度やフォーマットを示すログ書き込みフラグ。
ErrorDWORDin記録するWin32エラーコード。
MessageStrLPCSTRinエラーに添えるメッセージ書式文字列(ANSI)。

戻り値の型: void

各言語での呼び出し定義

// SETUPAPI.dll
#include <windows.h>

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

SetupWriteTextLogError = ctypes.cdll.setupapi.SetupWriteTextLogError
SetupWriteTextLogError.restype = None
SetupWriteTextLogError.argtypes = [
    ctypes.c_ulonglong,  # LogToken : ULONGLONG
    wintypes.DWORD,  # Category : DWORD
    wintypes.DWORD,  # LogFlags : DWORD
    wintypes.DWORD,  # Error : DWORD
    wintypes.LPCSTR,  # MessageStr : LPCSTR
]
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupWriteTextLogError = Fiddle::Function.new(
  lib['SetupWriteTextLogError'],
  [
    -Fiddle::TYPE_LONG_LONG,  # LogToken : ULONGLONG
    -Fiddle::TYPE_INT,  # Category : DWORD
    -Fiddle::TYPE_INT,  # LogFlags : DWORD
    -Fiddle::TYPE_INT,  # Error : DWORD
    Fiddle::TYPE_VOIDP,  # MessageStr : LPCSTR
  ],
  Fiddle::TYPE_VOID, Fiddle::Function::CDECL)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#[link(name = "setupapi")]
extern "C" {
    fn SetupWriteTextLogError(
        LogToken: u64,  // ULONGLONG
        Category: u32,  // DWORD
        LogFlags: u32,  // DWORD
        Error: u32,  // DWORD
        MessageStr: *const u8,  // LPCSTR
        ...
    );
}
// crates: windows-sys provides ready-made bindings for this API.
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
$sig = @"
[DllImport("SETUPAPI.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern void SetupWriteTextLogError(ulong LogToken, uint Category, uint LogFlags, uint Error, [MarshalAs(UnmanagedType.LPStr)] string MessageStr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupWriteTextLogError' -Namespace Win32 -PassThru
# $api::SetupWriteTextLogError(LogToken, Category, LogFlags, Error, MessageStr)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "SETUPAPI.dll"
#func global SetupWriteTextLogError "SetupWriteTextLogError" sptr, sptr, sptr, sptr, sptr
; SetupWriteTextLogError LogToken, Category, LogFlags, Error, MessageStr
; LogToken : ULONGLONG -> "sptr"
; Category : DWORD -> "sptr"
; LogFlags : DWORD -> "sptr"
; Error : DWORD -> "sptr"
; MessageStr : LPCSTR -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "SETUPAPI.dll"
#func global SetupWriteTextLogError "SetupWriteTextLogError" int64, int, int, int, str
; SetupWriteTextLogError LogToken, Category, LogFlags, Error, MessageStr
; LogToken : ULONGLONG -> "int64"
; Category : DWORD -> "int"
; LogFlags : DWORD -> "int"
; Error : DWORD -> "int"
; MessageStr : LPCSTR -> "str"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
; void SetupWriteTextLogError(ULONGLONG LogToken, DWORD Category, DWORD LogFlags, DWORD Error, LPCSTR MessageStr)
#uselib "SETUPAPI.dll"
#func global SetupWriteTextLogError "SetupWriteTextLogError" int64, int, int, int, str
; SetupWriteTextLogError LogToken, Category, LogFlags, Error, MessageStr
; LogToken : ULONGLONG -> "int64"
; Category : DWORD -> "int"
; LogFlags : DWORD -> "int"
; Error : DWORD -> "int"
; MessageStr : LPCSTR -> "str"
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupWriteTextLogError = setupapi.NewProc("SetupWriteTextLogError")
)

// LogToken (ULONGLONG), Category (DWORD), LogFlags (DWORD), Error (DWORD), MessageStr (LPCSTR)
r1, _, err := procSetupWriteTextLogError.Call(
	uintptr(LogToken),
	uintptr(Category),
	uintptr(LogFlags),
	uintptr(Error),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(MessageStr))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
procedure SetupWriteTextLogError(
  LogToken: UInt64;   // ULONGLONG
  Category: DWORD;   // DWORD
  LogFlags: DWORD;   // DWORD
  Error: DWORD;   // DWORD
  MessageStr: PAnsiChar   // LPCSTR
); cdecl; varargs;
  external 'SETUPAPI.dll' name 'SetupWriteTextLogError';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
result := DllCall("SETUPAPI\SetupWriteTextLogError"
    , "Int64", LogToken   ; ULONGLONG
    , "UInt", Category   ; DWORD
    , "UInt", LogFlags   ; DWORD
    , "UInt", Error   ; DWORD
    , "AStr", MessageStr   ; LPCSTR
    , "Cdecl Int")   ; return: void
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
●SetupWriteTextLogError(LogToken, Category, LogFlags, Error, MessageStr) = DLL("SETUPAPI.dll", "int SetupWriteTextLogError(qword, dword, dword, dword, char*)")
# 呼び出し: SetupWriteTextLogError(LogToken, Category, LogFlags, Error, MessageStr)
# LogToken : ULONGLONG -> "qword"
# Category : DWORD -> "dword"
# LogFlags : DWORD -> "dword"
# Error : DWORD -> "dword"
# MessageStr : 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 "setupapi" fn SetupWriteTextLogError(
    LogToken: u64, // ULONGLONG
    Category: u32, // DWORD
    LogFlags: u32, // DWORD
    Error: u32, // DWORD
    MessageStr: [*c]const u8, // LPCSTR
    ...
) callconv(.c) void;
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
proc SetupWriteTextLogError(
    LogToken: uint64,  # ULONGLONG
    Category: uint32,  # DWORD
    LogFlags: uint32,  # DWORD
    Error: uint32,  # DWORD
    MessageStr: cstring  # LPCSTR
) {.importc: "SetupWriteTextLogError", cdecl, varargs, dynlib: "SETUPAPI.dll".}
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
pragma(lib, "setupapi");
extern(C)
void SetupWriteTextLogError(
    ulong LogToken,   // ULONGLONG
    uint Category,   // DWORD
    uint LogFlags,   // DWORD
    uint Error,   // DWORD
    const(char)* MessageStr,   // LPCSTR
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
ccall((:SetupWriteTextLogError, "SETUPAPI.dll"), Cvoid,
      (UInt64, UInt32, UInt32, UInt32, Cstring),
      LogToken, Category, LogFlags, Error, MessageStr)
# LogToken : ULONGLONG -> UInt64
# Category : DWORD -> UInt32
# LogFlags : DWORD -> UInt32
# Error : DWORD -> UInt32
# MessageStr : LPCSTR -> Cstring
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
local ffi = require("ffi")
ffi.cdef[[
void SetupWriteTextLogError(
    uint64_t LogToken,
    uint32_t Category,
    uint32_t LogFlags,
    uint32_t Error,
    const char* MessageStr,
    ...);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupWriteTextLogError(LogToken, Category, LogFlags, Error, MessageStr)
-- LogToken : ULONGLONG
-- Category : DWORD
-- LogFlags : DWORD
-- Error : DWORD
-- MessageStr : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupWriteTextLogError = lib.func('__cdecl', 'SetupWriteTextLogError', 'void', ['uint64_t', 'uint32_t', 'uint32_t', 'uint32_t', 'str', '...']);
// SetupWriteTextLogError(LogToken, Category, LogFlags, Error, MessageStr)
// LogToken : ULONGLONG -> 'uint64_t'
// Category : DWORD -> 'uint32_t'
// LogFlags : DWORD -> 'uint32_t'
// Error : DWORD -> 'uint32_t'
// MessageStr : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupWriteTextLogError: { parameters: ["u64", "u32", "u32", "u32", "buffer"], result: "void" },
});
// lib.symbols.SetupWriteTextLogError(LogToken, Category, LogFlags, Error, MessageStr)
// LogToken : ULONGLONG -> "u64"
// Category : DWORD -> "u32"
// LogFlags : DWORD -> "u32"
// Error : DWORD -> "u32"
// MessageStr : LPCSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<?php
$ffi = FFI::cdef(<<<C
void SetupWriteTextLogError(
    uint64_t LogToken,
    uint32_t Category,
    uint32_t LogFlags,
    uint32_t Error,
    const char* MessageStr,
    ...);
C, "SETUPAPI.dll");
// $ffi->SetupWriteTextLogError(LogToken, Category, LogFlags, Error, MessageStr);
// LogToken : ULONGLONG
// Category : DWORD
// LogFlags : DWORD
// Error : DWORD
// MessageStr : 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 Setupapi extends Library {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class);
    void SetupWriteTextLogError(
        long LogToken,   // ULONGLONG
        int Category,   // DWORD
        int LogFlags,   // DWORD
        int Error,   // DWORD
        String MessageStr,   // LPCSTR
        Object... args   // 可変長引数(printf形式)
    );
}
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupWriteTextLogError = SetupWriteTextLogError(
    LogToken : UInt64,   # ULONGLONG
    Category : UInt32,   # DWORD
    LogFlags : UInt32,   # DWORD
    Error : UInt32,   # DWORD
    MessageStr : UInt8*,   # LPCSTR
    ...
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupWriteTextLogErrorNative = Void Function(Uint64, Uint32, Uint32, Uint32, Pointer<Utf8>);
typedef SetupWriteTextLogErrorDart = void Function(int, int, int, int, Pointer<Utf8>);
final SetupWriteTextLogError = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupWriteTextLogErrorNative, SetupWriteTextLogErrorDart>('SetupWriteTextLogError');
// LogToken : ULONGLONG -> Uint64
// Category : DWORD -> Uint32
// LogFlags : DWORD -> Uint32
// Error : DWORD -> Uint32
// MessageStr : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
{$mode objfpc}{$H+}
procedure SetupWriteTextLogError(
  LogToken: UInt64;   // ULONGLONG
  Category: DWORD;   // DWORD
  LogFlags: DWORD;   // DWORD
  Error: DWORD;   // DWORD
  MessageStr: PAnsiChar   // LPCSTR
); cdecl; varargs;
  external 'SETUPAPI.dll' name 'SetupWriteTextLogError';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setupwritetextlogerror =
  foreign "SetupWriteTextLogError"
    (uint64_t @-> uint32_t @-> uint32_t @-> uint32_t @-> string @-> returning void)
(* LogToken : ULONGLONG -> uint64_t *)
(* Category : DWORD -> uint32_t *)
(* LogFlags : DWORD -> uint32_t *)
(* Error : DWORD -> uint32_t *)
(* MessageStr : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(* ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupWriteTextLogError" setup-write-text-log-error :convention :cdecl) :void
  (log-token :uint64)   ; ULONGLONG
  (category :uint32)   ; DWORD
  (log-flags :uint32)   ; DWORD
  (error :uint32)   ; DWORD
  (message-str :string)   ; LPCSTR
  &rest)   ; 可変長引数(printf形式)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
use Win32::API;
my $SetupWriteTextLogError = Win32::API::More->new('SETUPAPI',
    'void SetupWriteTextLogError(UINT64 LogToken, DWORD Category, DWORD LogFlags, DWORD Error, LPCSTR MessageStr)');
# my $ret = $SetupWriteTextLogError->Call($LogToken, $Category, $LogFlags, $Error, $MessageStr);
# LogToken : ULONGLONG -> UINT64
# Category : DWORD -> DWORD
# LogFlags : DWORD -> DWORD
# Error : DWORD -> DWORD
# MessageStr : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。