ホーム › Devices.DeviceAndDriverInstallation › SetupQueryFileLogW

SetupQueryFileLogW

関数

ファイルログから指定ファイルの記録情報を取得する。

DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupQueryFileLogW(
    void* FileLogHandle,
    LPCWSTR LogSectionName,   // optional
    LPCWSTR TargetFilename,
    SetupFileLogInfo DesiredInfo,
    LPWSTR DataOut,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前

型

方向

説明

FileLogHandle

void*

SetupInitializeFileLog によって返された、ファイルログのハンドル。

LogSectionName

LPCWSTR

inoptional

呼び出し元にとって意味のある形式で表した、ログファイルのセクション名への省略可能なポインター。null で終わる文字列を使用してください。システムログ以外では必須です。システムログに対して LogSectionName が指定されていない場合は、既定値が使用されます。

TargetFilename

LPCWSTR

ログ情報を取得する対象のファイルの名前。null で終わる文字列を使用してください。

DesiredInfo

SetupFileLogInfo

DataOut バッファーに返す情報の種類を示します。このパラメーターには、次の列挙値のいずれかを指定できます。

値	意味
SetupFileLogSourceFile name	ソースメディア上に存在する、ソースファイルの名前
SetupFileLogChecksum	システムログで使用されるチェックサム値
SetupFileLogDiskTagfile	ソースファイルを含むメディアソースのタグファイルの名前
SetupFileLogDiskDescription	ソースファイルが存在するメディアの、人間が読める形式の説明
SetupFileLogOtherInfo	ログに記録されたファイルに関連付けられている追加情報

DesiredInfo の値が SetupFileLogOtherInfo より大きい場合、この関数は失敗し、GetLastError は ERROR_INVALID_PARAMETER を返します。

DataOut

LPWSTR

outoptional

この関数がファイルについて要求された情報を返す、バッファーへの省略可能なポインター。null で終わる文字列を使用してください。null で終わる文字列は、コピー先バッファーのサイズを超えないようにする必要があります。まず関数を 1 回呼び出して必要なバッファーサイズを取得し、必要なメモリを割り当ててから、もう一度関数を呼び出してデータを取得できます。「解説」セクションを参照してください。この方法を使用すると、バッファーサイズの不足によるエラーを回避できます。すべてのファイルについてすべての情報が提供されるわけではありません。ログ内にそのファイルの空のエントリが存在する場合でも、エラーは返されません。このパラメーターには NULL を指定できます。

ReturnBufferSize

DWORD

DataOut バッファーのサイズ (文字数単位)。これには null 終端文字が含まれます。バッファーが小さすぎて DataOut が指定されている場合、データはバッファーに格納されず、関数は 0 を返します。DataOut が指定されていない場合、ReturnBufferSize パラメーターは無視されます。

RequiredSize

DWORD*

outoptional

DataOut に必要なサイズ (文字数単位) を受け取る変数への省略可能なポインター。この数には null 終端文字が含まれます。

戻り値の型: BOOL

公式ドキュメント

SetupQueryFileLog 関数は、セットアップファイルログから情報を返します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

この関数を DataOut に NULL、ReturnBufferSize に 0 を指定して呼び出すと、指定されたデータを保持するために必要なバッファーサイズが、RequiredSize が指す変数に格納されます。これに成功した場合、戻り値は 0 以外の値です。それ以外の場合、戻り値は 0 であり、拡張エラー情報は GetLastError を呼び出すことで取得できます。

DesiredInfo の値が SetupFileLogOtherInfo より大きい場合、この関数は失敗し、 GetLastError は ERROR_INVALID_PARAMETER を返します。

メモ

setupapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetupQueryFileLog を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL SetupQueryFileLogW(
    void* FileLogHandle,
    LPCWSTR LogSectionName,   // optional
    LPCWSTR TargetFilename,
    SetupFileLogInfo DesiredInfo,
    LPWSTR DataOut,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupQueryFileLogW(
    IntPtr FileLogHandle,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string LogSectionName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string TargetFilename,   // LPCWSTR
    int DesiredInfo,   // SetupFileLogInfo
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder DataOut,   // LPWSTR optional, out
    uint ReturnBufferSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupQueryFileLogW(
    FileLogHandle As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> LogSectionName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> TargetFilename As String,   ' LPCWSTR
    DesiredInfo As Integer,   ' SetupFileLogInfo
    <MarshalAs(UnmanagedType.LPWStr)> DataOut As System.Text.StringBuilder,   ' LPWSTR optional, out
    ReturnBufferSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' FileLogHandle : void*
' LogSectionName : LPCWSTR optional
' TargetFilename : LPCWSTR
' DesiredInfo : SetupFileLogInfo
' DataOut : LPWSTR optional, out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupQueryFileLogW Lib "setupapi" ( _
    ByVal FileLogHandle As LongPtr, _
    ByVal LogSectionName As LongPtr, _
    ByVal TargetFilename As LongPtr, _
    ByVal DesiredInfo As Long, _
    ByVal DataOut As LongPtr, _
    ByVal ReturnBufferSize As Long, _
    ByVal RequiredSize 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

SetupQueryFileLogW = ctypes.windll.setupapi.SetupQueryFileLogW
SetupQueryFileLogW.restype = wintypes.BOOL
SetupQueryFileLogW.argtypes = [
    ctypes.POINTER(None),  # FileLogHandle : void*
    wintypes.LPCWSTR,  # LogSectionName : LPCWSTR optional
    wintypes.LPCWSTR,  # TargetFilename : LPCWSTR
    ctypes.c_int,  # DesiredInfo : SetupFileLogInfo
    wintypes.LPWSTR,  # DataOut : LPWSTR optional, out
    wintypes.DWORD,  # ReturnBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupQueryFileLogW = Fiddle::Function.new(
  lib['SetupQueryFileLogW'],
  [
    Fiddle::TYPE_VOIDP,  # FileLogHandle : void*
    Fiddle::TYPE_VOIDP,  # LogSectionName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # TargetFilename : LPCWSTR
    Fiddle::TYPE_INT,  # DesiredInfo : SetupFileLogInfo
    Fiddle::TYPE_VOIDP,  # DataOut : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # ReturnBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "setupapi")]
extern "system" {
    fn SetupQueryFileLogW(
        FileLogHandle: *mut (),  // void*
        LogSectionName: *const u16,  // LPCWSTR optional
        TargetFilename: *const u16,  // LPCWSTR
        DesiredInfo: i32,  // SetupFileLogInfo
        DataOut: *mut u16,  // LPWSTR optional, out
        ReturnBufferSize: u32,  // DWORD
        RequiredSize: *mut u32  // DWORD* optional, out
    ) -> 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 SetupQueryFileLogW(IntPtr FileLogHandle, [MarshalAs(UnmanagedType.LPWStr)] string LogSectionName, [MarshalAs(UnmanagedType.LPWStr)] string TargetFilename, int DesiredInfo, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder DataOut, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupQueryFileLogW' -Namespace Win32 -PassThru
# $api::SetupQueryFileLogW(FileLogHandle, LogSectionName, TargetFilename, DesiredInfo, DataOut, ReturnBufferSize, RequiredSize)

#uselib "SETUPAPI.dll"
#func global SetupQueryFileLogW "SetupQueryFileLogW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; SetupQueryFileLogW FileLogHandle, LogSectionName, TargetFilename, DesiredInfo, varptr(DataOut), ReturnBufferSize, varptr(RequiredSize)   ; 戻り値は stat
; FileLogHandle : void* -> "wptr"
; LogSectionName : LPCWSTR optional -> "wptr"
; TargetFilename : LPCWSTR -> "wptr"
; DesiredInfo : SetupFileLogInfo -> "wptr"
; DataOut : LPWSTR optional, out -> "wptr"
; ReturnBufferSize : DWORD -> "wptr"
; RequiredSize : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupQueryFileLogW "SetupQueryFileLogW" sptr, wstr, wstr, int, var, int, var
; res = SetupQueryFileLogW(FileLogHandle, LogSectionName, TargetFilename, DesiredInfo, DataOut, ReturnBufferSize, RequiredSize)
; FileLogHandle : void* -> "sptr"
; LogSectionName : LPCWSTR optional -> "wstr"
; TargetFilename : LPCWSTR -> "wstr"
; DesiredInfo : SetupFileLogInfo -> "int"
; DataOut : LPWSTR optional, out -> "var"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupQueryFileLogW "SetupQueryFileLogW" sptr, wstr, wstr, int, sptr, int, sptr
; res = SetupQueryFileLogW(FileLogHandle, LogSectionName, TargetFilename, DesiredInfo, varptr(DataOut), ReturnBufferSize, varptr(RequiredSize))
; FileLogHandle : void* -> "sptr"
; LogSectionName : LPCWSTR optional -> "wstr"
; TargetFilename : LPCWSTR -> "wstr"
; DesiredInfo : SetupFileLogInfo -> "int"
; DataOut : LPWSTR optional, out -> "sptr"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。