SetupWriteTextLogInfLine の呼び出し

アプリケーションは SetupWriteTextLogInfLine を呼び出して、指定された INF ファイル行のテキストを含むログ エントリを SetupAPI テキスト ログ に書き込むことができます。

SetupWriteTextLogInfLine を呼び出すために、アプリケーションは次の情報を提供します。

  • SetupGetThreadLogToken を呼び出すことによって取得された、またはシステム定義のログ トークンの 1 つである、テキスト ログ内のセクションのログ トークン。 ログ トークンがテキスト ログ セクションに関連付けられている場合、 SetupWriteTextLogInfLine はそのセクションにログ エントリを書き込みます。 それ以外の場合、 SetupWriteTextLogInfLine は、テキスト ログ セクションに含まれていないログの一部にログ エントリを追加します。

    さらに、 SetupWriteTextLogInfLine がログ エントリを書き込むかどうか、および SetupWriteTextLogInfLine がどのテキスト ログにエントリを書き込むかは、システム定義のログ トークン値によって異なります。

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

  • イベント レベル、インデントの深さ、およびタイム スタンプを含めるかどうかを指定する、システム定義定数のビットごとの OR であるフラグ値。 イベント レベルについては、「 テキスト ログのイベント レベルの設定」を参照してください。

    テキスト ログに設定されたイベント レベルがエントリのイベント レベル以上の場合、 SetupWriteTextLogInfLine はログ エントリをテキスト ログに書き込みます。 それ以外の場合、 SetupWriteTextLogInfLine では、テキスト ログにログ エントリは書き込まれません。 インデントを使用すると、書式設定されたメッセージを配置して、セクション内の情報を読みやすく理解しやすくできます。

    詳細については、「インデントされたログ エントリの書き込み」を参照してください。

  • INF ファイル行を含む INF ファイルへのハンドル。

  • INF ファイル行のコンテキスト。

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

entry_prefix time_stampinf:インデントされた inf-line-text(inf-file-name行line-number)

Where:

  • entry_prefix、タイムスタンプ、インデントの各フィールドは、「テキスト ログ セクション本文の形式」で説明されているものと同じです。

  • inf: フィールドは、TXTLOG_INFイベント カテゴリを指定します。 イベント カテゴリについては、テキスト ログのイベント カテゴリを有効にするを参照してください。

  • inf 行テキスト フィールドには、指定した INF ファイル行のテキストが含まれています。

  • inf-file-name フィールドには、指定した INF ファイル行を含む INF ファイルの名前が含まれています。

  • 行フィールドは、その後に続くものが INF ファイル内の行番号であることを示します。

  • 行番号フィールドには、INF ファイル内の指定した行の行番号が含まれています。

次の例は、アプリケーションが通常、INF 行のテキストをテキスト ログに記録する方法を示しています。 この例の INF 行は INF AddReg 行です。 アプリケーションは SetupWriteTextLogInfLine を呼び出し、次の入力パラメーター値を指定します。

  • LogToken は、 SetupGetThreadLogToken によって返されたログ トークンまたはシステム定義 のログ トークンに設定されます。

  • LogFlags が TXTLOG_DETAILS に設定されています。 この例では、タイム スタンプを含めたり、インデントの深さを変更したりしません。 この例では、インデントの深さは等幅スペース5文字分です。

  • InfHandle は、INF ファイル hidserv.inf へのハンドルに設定されます。このハンドルは、Platform SDK に記載されている SetupOpenInfFile 関数を呼び出すことによって取得されます。

  • コンテキスト は、"AddReg=HidServ_AddService_AddReg" というテキストを含む INF ファイル行の INF ファイル コンテキストに設定されます。行の INF ファイル コンテキストは、プラットフォーム SDK に記載されている SetupFindXxxLine 関数を呼び出すことによって取得されます。

LogToken と LogFlags の値は、SetupWriteTextLog について説明したのと同じ方法で SetupWriteTextLogInfLine の操作に影響します。 さらに、 SetupWriteTextLogInfLine はイベント カタログ TXTLOG_INFを使用します。

この例では、 SetupWriteTextLogInfLine がテキスト ログに書き込むログ エントリの種類を次に示します。

   inf:      AddReg=HidServ_AddService_AddReg  (hidserv.inf line 98)
  • 最終更新: