SetupWriteTextLog の呼び出し

SetupWriteTextLog は、インストール イベントに関する情報を含む 1 つのエントリを SetupAPI テキスト ログに追加します。

「テキスト ログ セクションの本文の形式」で説明されているように、ログ エントリの形式は次のフィールドで構成されます。

entry_prefix time_stamp event_category indentation formatted_message

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

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

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

• 「テキスト ログのイベント カテゴリの有効化」で説明されているイベント カテゴリの 1 つ。 エントリのイベント カテゴリがテキスト ログに対して有効になっている場合、SetupWriteTextLog は、テキスト ログにエントリを追加します。それ以外の場合、SetupWriteTextLog は、テキスト ログにエントリを書き込みません。

• イベント レベル、インデントの深さ、およびタイム スタンプを含めるかどうかを指定するシステム定義定数のビットごとの OR であるフラグ値。 イベント レベルについては、「テキスト ログのイベント レベルの設定」を参照してください。 テキスト ログに設定されたイベント レベルがエントリのイベント レベル以上の場合、SetupWriteTextLog はログ エントリをテキスト ログに書き込みます。それ以外の場合、SetupWriteTextLog は、ログ エントリをテキスト ログに書き込みません。 インデントを使用することによって、書式設定されたメッセージを配置し、セクション内の情報を読みやすく、理解しやすくできます。 詳細については、「インデントされたログ エントリの書き込み」を参照してください。

• printf 互換の書式指定文字列。メッセージと、書式指定文字列の後に続くコンマ区切り変数のリストの両方を書式設定します。

• printf 互換の書式指定文字列で書式設定された値を持つ変数のコンマ区切りのリスト。

SetupWriteTextLog を呼び出して、エラーまたは警告でないイベントに関する情報を記録する例については、「情報ログ エントリの書き込み」を参照してください。

SetupWriteTextLog を呼び出して、エラーまたは警告に関する情報を記録する例については、「エラーまたは警告ログ エントリの書き込み」を参照してください。