SetupQueryFileLogA 関数 (setupapi.h)

  • [アーティクル]

[この機能は、「要件」セクションに示されているオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 SetupAPI は、アプリケーションのインストールに使用されなくなりました。 代わりに、アプリケーション インストーラーを開発するために Windows インストーラーを使用します。 SetupAPI は、デバイス ドライバーのインストールに引き続き使用されます。]

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

構文

WINSETUPAPI BOOL SetupQueryFileLogA(
  [in]      HSPFILELOG       FileLogHandle,
  [in]      PCSTR            LogSectionName,
  [in]      PCSTR            TargetFilename,
  [in]      SetupFileLogInfo DesiredInfo,
  [in, out] PSTR             DataOut,
  [in]      DWORD            ReturnBufferSize,
  [in, out] PDWORD           RequiredSize
);

パラメーター

[in] FileLogHandle

SetupInitializeFileLog によって返されるファイル ログを処理します。

[in] LogSectionName

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

[in] TargetFilename

ログ情報が必要なファイルの名前。 null で終わる文字列を使用する必要があります。

[in] DesiredInfo

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

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

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

[in, out] DataOut

この関数がファイルに対して要求された情報を返すバッファーへのオプションのポインター。 null で終わる文字列を使用する必要があります。 null で終わる文字列は、宛先バッファーのサイズを超えてはなりません。 関数を 1 回呼び出して、必要なバッファー サイズを取得し、必要なメモリを割り当ててから、2 回目に関数を呼び出してデータを取得できます。 「解説」を参照してください。 この手法を使用すると、バッファー サイズが不十分なため、エラーを回避できます。 すべてのファイルに対してすべての情報が提供されるわけではありません。 ファイルの空のエントリがログに存在する場合、エラーは返されません。 このパラメーターは、NULL でもかまいません。

[in] ReturnBufferSize

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

[in, out] RequiredSize

DataOut の必要なサイズを文字で受け取る変数への省略可能なポインター。 この数値には 、null ターミネータが含まれます。

戻り値

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

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

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

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

注意

setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupQueryFileLog を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー setupapi.h
Library Setupapi.lib
[DLL] Setupapi.dll

関連項目

関数

概要

SetupLogFile