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

SetupLogErrorA

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

シグネチャ

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

BOOL SetupLogErrorA(
    LPCSTR MessageString,
    DWORD Severity
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupLogErrorA(
    LPCSTR MessageString,
    DWORD Severity
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupLogErrorA(
    [MarshalAs(UnmanagedType.LPStr)] string MessageString,   // LPCSTR
    uint Severity   // DWORD
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupLogErrorA(
    <MarshalAs(UnmanagedType.LPStr)> MessageString As String,   ' LPCSTR
    Severity As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' MessageString : LPCSTR
' Severity : DWORD
Declare PtrSafe Function SetupLogErrorA Lib "setupapi" ( _
    ByVal MessageString As String, _
    ByVal Severity As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupLogErrorA = ctypes.windll.setupapi.SetupLogErrorA
SetupLogErrorA.restype = wintypes.BOOL
SetupLogErrorA.argtypes = [
    wintypes.LPCSTR,  # MessageString : LPCSTR
    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')
SetupLogErrorA = Fiddle::Function.new(
  lib['SetupLogErrorA'],
  [
    Fiddle::TYPE_VOIDP,  # MessageString : LPCSTR
    -Fiddle::TYPE_INT,  # Severity : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupLogErrorA(
        MessageString: *const u8,  // LPCSTR
        Severity: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SetupLogErrorA([MarshalAs(UnmanagedType.LPStr)] string MessageString, uint Severity);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupLogErrorA' -Namespace Win32 -PassThru
# $api::SetupLogErrorA(MessageString, Severity)
#uselib "SETUPAPI.dll"
#func global SetupLogErrorA "SetupLogErrorA" sptr, sptr
; SetupLogErrorA MessageString, Severity   ; 戻り値は stat
; MessageString : LPCSTR -> "sptr"
; Severity : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SETUPAPI.dll"
#cfunc global SetupLogErrorA "SetupLogErrorA" str, int
; res = SetupLogErrorA(MessageString, Severity)
; MessageString : LPCSTR -> "str"
; Severity : DWORD -> "int"
; BOOL SetupLogErrorA(LPCSTR MessageString, DWORD Severity)
#uselib "SETUPAPI.dll"
#cfunc global SetupLogErrorA "SetupLogErrorA" str, int
; res = SetupLogErrorA(MessageString, Severity)
; MessageString : LPCSTR -> "str"
; Severity : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupLogErrorA = setupapi.NewProc("SetupLogErrorA")
)

// MessageString (LPCSTR), Severity (DWORD)
r1, _, err := procSetupLogErrorA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(MessageString))),
	uintptr(Severity),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupLogErrorA(
  MessageString: PAnsiChar;   // LPCSTR
  Severity: DWORD   // DWORD
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupLogErrorA';
result := DllCall("SETUPAPI\SetupLogErrorA"
    , "AStr", MessageString   ; LPCSTR
    , "UInt", Severity   ; DWORD
    , "Int")   ; return: BOOL
●SetupLogErrorA(MessageString, Severity) = DLL("SETUPAPI.dll", "bool SetupLogErrorA(char*, dword)")
# 呼び出し: SetupLogErrorA(MessageString, Severity)
# MessageString : LPCSTR -> "char*"
# Severity : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "setupapi" fn SetupLogErrorA(
    MessageString: [*c]const u8, // LPCSTR
    Severity: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SetupLogErrorA(
    MessageString: cstring,  # LPCSTR
    Severity: uint32  # DWORD
): int32 {.importc: "SetupLogErrorA", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupLogErrorA(
    const(char)* MessageString,   // LPCSTR
    uint Severity   // DWORD
);
ccall((:SetupLogErrorA, "SETUPAPI.dll"), stdcall, Int32,
      (Cstring, UInt32),
      MessageString, Severity)
# MessageString : LPCSTR -> Cstring
# Severity : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupLogErrorA(
    const char* MessageString,
    uint32_t Severity);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupLogErrorA(MessageString, Severity)
-- MessageString : LPCSTR
-- Severity : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupLogErrorA = lib.func('__stdcall', 'SetupLogErrorA', 'int32_t', ['str', 'uint32_t']);
// SetupLogErrorA(MessageString, Severity)
// MessageString : LPCSTR -> 'str'
// Severity : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupLogErrorA: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.SetupLogErrorA(MessageString, Severity)
// MessageString : LPCSTR -> "buffer"
// Severity : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupLogErrorA(
    const char* MessageString,
    uint32_t Severity);
C, "SETUPAPI.dll");
// $ffi->SetupLogErrorA(MessageString, Severity);
// MessageString : LPCSTR
// 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.ASCII_OPTIONS);
    boolean SetupLogErrorA(
        String MessageString,   // LPCSTR
        int Severity   // DWORD
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupLogErrorA = SetupLogErrorA(
    MessageString : UInt8*,   # LPCSTR
    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 SetupLogErrorANative = Int32 Function(Pointer<Utf8>, Uint32);
typedef SetupLogErrorADart = int Function(Pointer<Utf8>, int);
final SetupLogErrorA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupLogErrorANative, SetupLogErrorADart>('SetupLogErrorA');
// MessageString : LPCSTR -> Pointer<Utf8>
// Severity : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupLogErrorA(
  MessageString: PAnsiChar;   // LPCSTR
  Severity: DWORD   // DWORD
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupLogErrorA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setuplogerrora =
  foreign "SetupLogErrorA"
    (string @-> uint32_t @-> returning int32_t)
(* MessageString : LPCSTR -> string *)
(* 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 ("SetupLogErrorA" setup-log-error-a :convention :stdcall) :int32
  (message-string :string)   ; LPCSTR
  (severity :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupLogErrorA = Win32::API::More->new('SETUPAPI',
    'BOOL SetupLogErrorA(LPCSTR MessageString, DWORD Severity)');
# my $ret = $SetupLogErrorA->Call($MessageString, $Severity);
# MessageString : LPCSTR -> LPCSTR
# Severity : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い