SetupWriteTextLog 関数 (setupapi.h)

SetupWriteTextLog 関数は、SetupAPI テキスト ログにログ エントリを書き込みます。

構文

WINSETUPAPI VOID SetupWriteTextLog(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        Flags,
  [in] PCSTR        MessageStr,
       ...          
);

パラメーター

[in] LogToken

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

[in] Category

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

[in] Flags

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

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

[in] MessageStr

ログ エントリに含める書式設定されたメッセージを指定する 、printf 互換の書式指定文字列を含む NULL で終わる定数文字列へのポインター。 MessageStr に続くコンマ区切りのパラメーター リストは、書式指定文字列の書式指定子と一致する必要があります。

...

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

戻り値

なし

解説

LogToken の値が SetupGetThreadLogToken の呼び出しによって返され、対応するテキスト ログ セクションが見つかった場合、SetupWriteTextLog はそのテキスト ログ セクションにログ エントリを書き込みます。 SetupWriteTextLog でセクションが見つからない場合、SetupWriteTextLog は対応するテキスト ログにログ エントリを書き込みますが、セクションにログ エントリは含まれません。

LogToken の値が次の表に示すシステム定義のログ トークンの 1 つである場合、SetupWriteTextLog は、そのログ トークンに対して示される書き込み操作を実行します。

システム定義ログ トークン 書き込み操作
LOGTOKEN_NOLOG ログ エントリはどのテキスト ログにも書き込まれません。
LOG_TOKEN_UNSPECIFIED ログ エントリは、アプリケーション のインストール テキスト ログに書き込まれます。 ログ エントリは、 テキスト ログ セクションには含まれません。
LOGTOKEN_SETUPAPI_APPLOG ログ エントリは、アプリケーション のインストール テキスト ログに書き込まれます。 ログ エントリは、テキスト ログ セクションには含まれません。
LOGTOKEN_SETUPAPI_DEVLOG ログ エントリは、デバイスのインストール テキスト ログに書き込まれます。 ログ エントリは、テキスト ログ セクションには含まれません。
 
メモLogToken の値をシステム定義のログ トークンのいずれかに設定しても、スレッドの現在のログ トークンの値は変更されません。
 
さらに、 SetupWriteTextLog では、次のいずれかが当てはまる場合、ログ エントリは書き込まれません。 ログ エントリの最大長 (文字数) は 336 です。

SetupAPI 固有のエラーまたは Win32 エラーに関する情報をテキスト ログに書き込むには、アプリケーションで SetupWriteTextLogError を使用できます。

SetupAPI テキスト ログへのログ エントリの書き込みに関する一般的な情報については、「 SetupAPI ログ (Windows Vista 以降)」を参照してください。

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

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

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

要件

要件
サポートされている最小のクライアント Windows Vista 以降のバージョンの Windows で使用できます。
対象プラットフォーム デスクトップ
Header setupapi.h (Setupapi.h を含む)
Library Setupapi.lib
API セット ext-ms-win-setupapi-logging-l1-1-0 (Windows 8 で導入)

こちらもご覧ください

SetupGetThreadLogToken

SetupWriteTextLogError