SetupWriteTextLogInfLine 関数 (setupapi.h)

  • [アーティクル]

SetupWriteTextLogInfLine 関数は、指定された INF ファイル行のテキストを含む SetupAPI テキスト ログにログ エントリを書き込みます。

構文

WINSETUPAPI VOID SetupWriteTextLogInfLine(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Flags,
  [in] HINF         InfHandle,
  [in] PINFCONTEXT  Context
);

パラメーター

[in] LogToken

システム定義 のログ トークン であるか、 SetupGetThreadLogToken によって返されたログ トークン。

[in] Flags

次を指定するフラグ値のビットごとの OR である DWORD 型の値。

  • ログ エントリのイベント レベル。 ログ エントリに指定できるイベント レベルは、テキスト ログに対して有効にできるイベント レベルと同じです。 イベント レベル フラグの一覧については、「 SetupAPI テキスト ログのイベント レベルの設定」を参照してください。
  • ログ エントリにタイム スタンプを含めるかどうか。 タイム スタンプ フラグの値がTXTLOG_TIMESTAMP。
  • セクションのインデントの深さと現在のログ エントリへの変更 (存在する場合)。 インデント フラグの使用方法については、「 インデントされたログ エントリの書き込み」を参照してください。

[in] InfHandle

テキスト ログに書き込まれるテキスト行を含む INF ファイルへのハンドル。 INF ファイルへのハンドルは、プラットフォーム SDK に記載されている SetupOpenInfFile を呼び出すことによって取得されます。

[in] Context

テキスト ログに書き込むテキスト行を指定する INF ファイル コンテキストへのポインター。 行の INF ファイル コンテキストは、 SetupFindXxxLine 関数を呼び出すことによって取得されます。 INF ファイルと INF ファイル コンテキストの詳細については、INF ファイルの使用、INF ファイル コンテキストの取得、INFCONTEXT 構造体に関するプラットフォーム SDK で提供されている情報を参照してください。

戻り値

なし

解説

SetupWriteTextLogInfLine は、次の形式でログ エントリを書き込みます。

entry-prefixtime-stampinf:インデントinf-line-text(inf-file-nameline-number)

各値の説明:

  • エントリ プレフィックスフィールドとタイム スタンプ フィールドは、「テキスト ログ セクション本文の形式」で説明されているものと同じです。
  • inf-line-text フィールドには、指定した INF ファイル行のテキストが含まれます。
  • inf-file-name フィールドには、指定した INF ファイル行を含む INF ファイルの名前が含まれます。
  • 行番号フィールドには、INF ファイル内の指定した行の行番号が含まれます。
呼び出し元が提供するログ トークンとフラグは、 SetupWriteTextLog と SetupWriteTextLogError で説明したのと同じ方法で SetupWriteTextLogInfLine の操作 に影響します。 さらに、 SetupWriteTextLogInfLine は イベント カテゴリ TXTLOG_INFを使用します。

SetupAPI テキスト ログにログ エントリを書き込む方法の一般的な情報については、「 SetupAPI Logging (Windows Vista)」を参照してください。

SetupWriteTextLogInfLine の操作の詳細については、「SetupWriteTextLogInfLine の呼び出し」を参照してください。

さまざまな種類のログ トークンの詳細については、「 ログ トークン」を参照してください。

ログ トークンの使用の詳細については、「スレッドの ログ トークンの設定と取得」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Vista 以降のバージョンの Windows で使用できます。
対象プラットフォーム デスクトップ
Header setupapi.h (Setupapi.h を含む)
Library Setupapi.lib
[DLL] Setupapi.dll

こちらもご覧ください

SetupGetThreadLogToken

SetupWriteTextLog

SetupWriteTextLogError