SetupWriteTextLogError 関数 (setupapi.h)

  • [アーティクル]

SetupWriteTextLogError 関数は、SetupAPI 固有のエラーまたは Win32 システム エラーに関する情報を SetupAPI テキスト ログに書き込みます。

構文

WINSETUPAPI VOID SetupWriteTextLogError(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        LogFlags,
  [in] DWORD        Error,
  [in] PCSTR        MessageStr,
       ...          
);

パラメーター

[in] LogToken

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

[in] Category

ログ エントリのイベント カテゴリを示す DWORD 型の値。 ログ エントリに指定できるイベント カテゴリは、テキスト ログに対して有効にできるイベント カテゴリと同じです。 イベント カテゴリの一覧については、「 SetupAPI テキスト ログのイベント カテゴリの有効化」を参照してください。

[in] LogFlags

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

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

[in] Error

SetupAPI 固有のエラー コードまたは Win32 エラー コード。 SetupAPI 固有のエラー コードについては、「 Setupapi.h」を参照してください。 Win32 エラー コードは 、Winerror.h に記載されています。

[in] MessageStr

ログ エントリに含める書式設定されたメッセージを指定する 、printf 互換の書式指定文字列を含む NULL で終わる定数文字列へのポインター。

...

MessageStr によって提供される書式指定文字列の書式指定子と一致するコンマ区切りのパラメーター リスト。

戻り値

なし

解説

インストール アプリケーションに SetupAPI 固有のエラー コードまたは Win32 エラー コードがインストール エラーに関連付けられている場合、アプリケーションは SetupWriteTextLog ではなく SetupWriteTextLogError を呼び出して、2 つのエントリをテキスト ログに書き込むことができます。 最初のエントリは SetupWriteTextLog によって記述されたエントリと同じになり、2 番目のエントリはエラー コードとエラーのわかりやすい説明をログに記録します。

呼び出し元が提供するログ トークン、イベント カテゴリ、フラグは 、SetupWriteTextLogError の操作に影響を与えます。 これは、SetupWriteTextLog で説明したのと同じ方法です。

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

entry-prefixtime_stamp カテゴリインデントformatted-message

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

entry-prefixtime_stampカテゴリのインデントエラー:error-numbererror-description

各値の説明:

  • エントリ プレフィックス、タイムスタンプ、カテゴリ、インデント、および書式設定されたメッセージフィールドは、「テキスト ログ セクション本文の書式設定」で説明されているものと同じです。
  • error-number フィールドにはエラー番号が含まれています。
  • error-description フィールドには、エラーのわかりやすい説明が含まれています。
SetupAPI テキスト ログでのログ エントリの書き込みに関する一般的な情報については、「 SetupAPI Logging (Windows Vista)」を参照してください。

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

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

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

要件

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

こちらもご覧ください

SetupGetThreadLogToken

SetupWriteTextLog