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

SetupLogErrorW

関数
セットアップログにエラーメッセージを重大度付きで記録する。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// SETUPAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL SetupLogErrorW(
    LPCWSTR MessageString,
    DWORD Severity
);

パラメーター

名前方向説明
MessageStringLPCWSTRinテキストログへ記録するメッセージ文字列(Unicode)。
SeverityDWORDinエラーの重大度を示すLogSeverity値。

戻り値の型: BOOL

各言語での呼び出し定義

// SETUPAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL SetupLogErrorW(
    LPCWSTR MessageString,
    DWORD Severity
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupLogErrorW(
    [MarshalAs(UnmanagedType.LPWStr)] string MessageString,   // LPCWSTR
    uint Severity   // DWORD
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupLogErrorW(
    <MarshalAs(UnmanagedType.LPWStr)> MessageString As String,   ' LPCWSTR
    Severity As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' MessageString : LPCWSTR
' Severity : DWORD
Declare PtrSafe Function SetupLogErrorW Lib "setupapi" ( _
    ByVal MessageString As LongPtr, _
    ByVal Severity As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupLogErrorW = ctypes.windll.setupapi.SetupLogErrorW
SetupLogErrorW.restype = wintypes.BOOL
SetupLogErrorW.argtypes = [
    wintypes.LPCWSTR,  # MessageString : LPCWSTR
    wintypes.DWORD,  # Severity : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupLogErrorW = Fiddle::Function.new(
  lib['SetupLogErrorW'],
  [
    Fiddle::TYPE_VOIDP,  # MessageString : LPCWSTR
    -Fiddle::TYPE_INT,  # Severity : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupLogErrorW(
        MessageString: *const u16,  // LPCWSTR
        Severity: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetupLogErrorW([MarshalAs(UnmanagedType.LPWStr)] string MessageString, uint Severity);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupLogErrorW' -Namespace Win32 -PassThru
# $api::SetupLogErrorW(MessageString, Severity)
#uselib "SETUPAPI.dll"
#func global SetupLogErrorW "SetupLogErrorW" wptr, wptr
; SetupLogErrorW MessageString, Severity   ; 戻り値は stat
; MessageString : LPCWSTR -> "wptr"
; Severity : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SETUPAPI.dll"
#cfunc global SetupLogErrorW "SetupLogErrorW" wstr, int
; res = SetupLogErrorW(MessageString, Severity)
; MessageString : LPCWSTR -> "wstr"
; Severity : DWORD -> "int"
; BOOL SetupLogErrorW(LPCWSTR MessageString, DWORD Severity)
#uselib "SETUPAPI.dll"
#cfunc global SetupLogErrorW "SetupLogErrorW" wstr, int
; res = SetupLogErrorW(MessageString, Severity)
; MessageString : LPCWSTR -> "wstr"
; Severity : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupLogErrorW = setupapi.NewProc("SetupLogErrorW")
)

// MessageString (LPCWSTR), Severity (DWORD)
r1, _, err := procSetupLogErrorW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(MessageString))),
	uintptr(Severity),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupLogErrorW(
  MessageString: PWideChar;   // LPCWSTR
  Severity: DWORD   // DWORD
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupLogErrorW';
result := DllCall("SETUPAPI\SetupLogErrorW"
    , "WStr", MessageString   ; LPCWSTR
    , "UInt", Severity   ; DWORD
    , "Int")   ; return: BOOL
●SetupLogErrorW(MessageString, Severity) = DLL("SETUPAPI.dll", "bool SetupLogErrorW(char*, dword)")
# 呼び出し: SetupLogErrorW(MessageString, Severity)
# MessageString : LPCWSTR -> "char*"
# Severity : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "setupapi" fn SetupLogErrorW(
    MessageString: [*c]const u16, // LPCWSTR
    Severity: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetupLogErrorW(
    MessageString: WideCString,  # LPCWSTR
    Severity: uint32  # DWORD
): int32 {.importc: "SetupLogErrorW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "setupapi");
extern(Windows)
int SetupLogErrorW(
    const(wchar)* MessageString,   // LPCWSTR
    uint Severity   // DWORD
);
ccall((:SetupLogErrorW, "SETUPAPI.dll"), stdcall, Int32,
      (Cwstring, UInt32),
      MessageString, Severity)
# MessageString : LPCWSTR -> Cwstring
# Severity : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupLogErrorW(
    const uint16_t* MessageString,
    uint32_t Severity);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupLogErrorW(MessageString, Severity)
-- MessageString : LPCWSTR
-- Severity : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupLogErrorW = lib.func('__stdcall', 'SetupLogErrorW', 'int32_t', ['str16', 'uint32_t']);
// SetupLogErrorW(MessageString, Severity)
// MessageString : LPCWSTR -> 'str16'
// Severity : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupLogErrorW: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.SetupLogErrorW(MessageString, Severity)
// MessageString : LPCWSTR -> "buffer"
// Severity : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupLogErrorW(
    const uint16_t* MessageString,
    uint32_t Severity);
C, "SETUPAPI.dll");
// $ffi->SetupLogErrorW(MessageString, Severity);
// MessageString : LPCWSTR
// Severity : 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 Setupapi extends StdCallLibrary {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SetupLogErrorW(
        WString MessageString,   // LPCWSTR
        int Severity   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupLogErrorW = SetupLogErrorW(
    MessageString : UInt16*,   # LPCWSTR
    Severity : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupLogErrorWNative = Int32 Function(Pointer<Utf16>, Uint32);
typedef SetupLogErrorWDart = int Function(Pointer<Utf16>, int);
final SetupLogErrorW = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupLogErrorWNative, SetupLogErrorWDart>('SetupLogErrorW');
// MessageString : LPCWSTR -> Pointer<Utf16>
// Severity : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupLogErrorW(
  MessageString: PWideChar;   // LPCWSTR
  Severity: DWORD   // DWORD
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupLogErrorW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupLogErrorW"
  c_SetupLogErrorW :: CWString -> Word32 -> IO CInt
-- MessageString : LPCWSTR -> CWString
-- Severity : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setuplogerrorw =
  foreign "SetupLogErrorW"
    ((ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* MessageString : LPCWSTR -> (ptr uint16_t) *)
(* Severity : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupLogErrorW" setup-log-error-w :convention :stdcall) :int32
  (message-string (:string :encoding :utf-16le))   ; LPCWSTR
  (severity :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupLogErrorW = Win32::API::More->new('SETUPAPI',
    'BOOL SetupLogErrorW(LPCWSTR MessageString, DWORD Severity)');
# my $ret = $SetupLogErrorW->Call($MessageString, $Severity);
# MessageString : LPCWSTR -> LPCWSTR
# Severity : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い