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

SetupRemoveFileLogEntryW

関数
指定ファイルのエントリをセットアップファイルログから削除する。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupRemoveFileLogEntryW(
    void* FileLogHandle,
    LPCWSTR LogSectionName,   // optional
    LPCWSTR TargetFilename   // optional
);

パラメーター

名前方向説明
FileLogHandlevoid*inエントリを削除するファイルログのハンドル。
LogSectionNameLPCWSTRinoptional対象エントリが属するセクション名(Unicode)。NULL可。
TargetFilenameLPCWSTRinoptional削除する対象のターゲットファイル名(Unicode)。NULLでセクション全体を削除。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupRemoveFileLogEntryW(
    void* FileLogHandle,
    LPCWSTR LogSectionName,   // optional
    LPCWSTR TargetFilename   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupRemoveFileLogEntryW(
    IntPtr FileLogHandle,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string LogSectionName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string TargetFilename   // LPCWSTR optional
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupRemoveFileLogEntryW(
    FileLogHandle As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> LogSectionName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> TargetFilename As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FileLogHandle : void*
' LogSectionName : LPCWSTR optional
' TargetFilename : LPCWSTR optional
Declare PtrSafe Function SetupRemoveFileLogEntryW Lib "setupapi" ( _
    ByVal FileLogHandle As LongPtr, _
    ByVal LogSectionName As LongPtr, _
    ByVal TargetFilename As LongPtr) 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

SetupRemoveFileLogEntryW = ctypes.windll.setupapi.SetupRemoveFileLogEntryW
SetupRemoveFileLogEntryW.restype = wintypes.BOOL
SetupRemoveFileLogEntryW.argtypes = [
    ctypes.POINTER(None),  # FileLogHandle : void*
    wintypes.LPCWSTR,  # LogSectionName : LPCWSTR optional
    wintypes.LPCWSTR,  # TargetFilename : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupRemoveFileLogEntryW = Fiddle::Function.new(
  lib['SetupRemoveFileLogEntryW'],
  [
    Fiddle::TYPE_VOIDP,  # FileLogHandle : void*
    Fiddle::TYPE_VOIDP,  # LogSectionName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # TargetFilename : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupRemoveFileLogEntryW(
        FileLogHandle: *mut (),  // void*
        LogSectionName: *const u16,  // LPCWSTR optional
        TargetFilename: *const u16  // LPCWSTR optional
    ) -> 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 SetupRemoveFileLogEntryW(IntPtr FileLogHandle, [MarshalAs(UnmanagedType.LPWStr)] string LogSectionName, [MarshalAs(UnmanagedType.LPWStr)] string TargetFilename);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupRemoveFileLogEntryW' -Namespace Win32 -PassThru
# $api::SetupRemoveFileLogEntryW(FileLogHandle, LogSectionName, TargetFilename)
#uselib "SETUPAPI.dll"
#func global SetupRemoveFileLogEntryW "SetupRemoveFileLogEntryW" wptr, wptr, wptr
; SetupRemoveFileLogEntryW FileLogHandle, LogSectionName, TargetFilename   ; 戻り値は stat
; FileLogHandle : void* -> "wptr"
; LogSectionName : LPCWSTR optional -> "wptr"
; TargetFilename : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SETUPAPI.dll"
#cfunc global SetupRemoveFileLogEntryW "SetupRemoveFileLogEntryW" sptr, wstr, wstr
; res = SetupRemoveFileLogEntryW(FileLogHandle, LogSectionName, TargetFilename)
; FileLogHandle : void* -> "sptr"
; LogSectionName : LPCWSTR optional -> "wstr"
; TargetFilename : LPCWSTR optional -> "wstr"
; BOOL SetupRemoveFileLogEntryW(void* FileLogHandle, LPCWSTR LogSectionName, LPCWSTR TargetFilename)
#uselib "SETUPAPI.dll"
#cfunc global SetupRemoveFileLogEntryW "SetupRemoveFileLogEntryW" intptr, wstr, wstr
; res = SetupRemoveFileLogEntryW(FileLogHandle, LogSectionName, TargetFilename)
; FileLogHandle : void* -> "intptr"
; LogSectionName : LPCWSTR optional -> "wstr"
; TargetFilename : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupRemoveFileLogEntryW = setupapi.NewProc("SetupRemoveFileLogEntryW")
)

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

extern "setupapi" fn SetupRemoveFileLogEntryW(
    FileLogHandle: ?*anyopaque, // void*
    LogSectionName: [*c]const u16, // LPCWSTR optional
    TargetFilename: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetupRemoveFileLogEntryW(
    FileLogHandle: pointer,  # void*
    LogSectionName: WideCString,  # LPCWSTR optional
    TargetFilename: WideCString  # LPCWSTR optional
): int32 {.importc: "SetupRemoveFileLogEntryW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "setupapi");
extern(Windows)
int SetupRemoveFileLogEntryW(
    void* FileLogHandle,   // void*
    const(wchar)* LogSectionName,   // LPCWSTR optional
    const(wchar)* TargetFilename   // LPCWSTR optional
);
ccall((:SetupRemoveFileLogEntryW, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Cwstring),
      FileLogHandle, LogSectionName, TargetFilename)
# FileLogHandle : void* -> Ptr{Cvoid}
# LogSectionName : LPCWSTR optional -> Cwstring
# TargetFilename : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupRemoveFileLogEntryW(
    void* FileLogHandle,
    const uint16_t* LogSectionName,
    const uint16_t* TargetFilename);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupRemoveFileLogEntryW(FileLogHandle, LogSectionName, TargetFilename)
-- FileLogHandle : void*
-- LogSectionName : LPCWSTR optional
-- TargetFilename : LPCWSTR optional
-- 構造体/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 SetupRemoveFileLogEntryW = lib.func('__stdcall', 'SetupRemoveFileLogEntryW', 'int32_t', ['void *', 'str16', 'str16']);
// SetupRemoveFileLogEntryW(FileLogHandle, LogSectionName, TargetFilename)
// FileLogHandle : void* -> 'void *'
// LogSectionName : LPCWSTR optional -> 'str16'
// TargetFilename : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupRemoveFileLogEntryW: { parameters: ["pointer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.SetupRemoveFileLogEntryW(FileLogHandle, LogSectionName, TargetFilename)
// FileLogHandle : void* -> "pointer"
// LogSectionName : LPCWSTR optional -> "buffer"
// TargetFilename : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupRemoveFileLogEntryW(
    void* FileLogHandle,
    const uint16_t* LogSectionName,
    const uint16_t* TargetFilename);
C, "SETUPAPI.dll");
// $ffi->SetupRemoveFileLogEntryW(FileLogHandle, LogSectionName, TargetFilename);
// FileLogHandle : void*
// LogSectionName : LPCWSTR optional
// TargetFilename : LPCWSTR optional
// 構造体/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 SetupRemoveFileLogEntryW(
        Pointer FileLogHandle,   // void*
        WString LogSectionName,   // LPCWSTR optional
        WString TargetFilename   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupRemoveFileLogEntryW = SetupRemoveFileLogEntryW(
    FileLogHandle : Void*,   # void*
    LogSectionName : UInt16*,   # LPCWSTR optional
    TargetFilename : UInt16*   # LPCWSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupRemoveFileLogEntryWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>);
typedef SetupRemoveFileLogEntryWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>);
final SetupRemoveFileLogEntryW = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupRemoveFileLogEntryWNative, SetupRemoveFileLogEntryWDart>('SetupRemoveFileLogEntryW');
// FileLogHandle : void* -> Pointer<Void>
// LogSectionName : LPCWSTR optional -> Pointer<Utf16>
// TargetFilename : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupRemoveFileLogEntryW(
  FileLogHandle: Pointer;   // void*
  LogSectionName: PWideChar;   // LPCWSTR optional
  TargetFilename: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupRemoveFileLogEntryW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupRemoveFileLogEntryW"
  c_SetupRemoveFileLogEntryW :: Ptr () -> CWString -> CWString -> IO CInt
-- FileLogHandle : void* -> Ptr ()
-- LogSectionName : LPCWSTR optional -> CWString
-- TargetFilename : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupremovefilelogentryw =
  foreign "SetupRemoveFileLogEntryW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* FileLogHandle : void* -> (ptr void) *)
(* LogSectionName : LPCWSTR optional -> (ptr uint16_t) *)
(* TargetFilename : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupRemoveFileLogEntryW" setup-remove-file-log-entry-w :convention :stdcall) :int32
  (file-log-handle :pointer)   ; void*
  (log-section-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (target-filename (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupRemoveFileLogEntryW = Win32::API::More->new('SETUPAPI',
    'BOOL SetupRemoveFileLogEntryW(LPVOID FileLogHandle, LPCWSTR LogSectionName, LPCWSTR TargetFilename)');
# my $ret = $SetupRemoveFileLogEntryW->Call($FileLogHandle, $LogSectionName, $TargetFilename);
# FileLogHandle : void* -> LPVOID
# LogSectionName : LPCWSTR optional -> LPCWSTR
# TargetFilename : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い