SetupLogErrorW 関数 (setupapi.h)

  • [アーティクル]

[この機能は、「要件」セクションに示されているオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 SetupAPI は、アプリケーションのインストールに使用されなくなりました。 代わりに、アプリケーション インストーラーを開発するために Windows インストーラーを使用します。 SetupAPI は、デバイス ドライバーのインストールに引き続き使用されます。]

SetupLogError 関数は、エラー メッセージをログ ファイルに書き込みます。 Windows のインストール中に使用することを意図していますが、常に使用できます。 オペレーティング システムのインストール後に使用することを意図したものではありません。代わりにイベント ログを使用する必要があります。

構文

WINSETUPAPI BOOL SetupLogErrorW(
  [in] LPCWSTR     MessageString,
  [in] LogSeverity Severity
);

パラメーター

[in] MessageString

セットアップのログに保存する文字列へのポインター。 メッセージは、return-linefeed の組み合わせ (\r\n) で終わる必要があります。 null で終わる文字列を使用する必要があります。 null で終わる文字列は、宛先バッファーのサイズを超えてはなりません。 メッセージは常にアクション ログに保存setupact.log。 重大度が LogSevWarning、LogSevError、または LogSevFatalError の場合は、メッセージもエラー ログsetuperr.logに保存されます。 どちらのログも Windows ディレクトリに格納されます。

[in] Severity

メッセージの重大度。 LogSevInformation、 LogSevWarning、 LogSevError、 LogSevFatalError のいずれか。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

  • アクション ログは、Windows のインストール中にシステムに加えられたすべての変更を記録するためのものです。
  • エラー ログは、Windows のインストール中のエラーのみを対象としています。
  • MessageString パラメーターは、セットアップによってさらに書式設定される場合があります (ただし、追加の処理は行われません)。
  • エラー ログは、システムセットアップの終了時にユーザーに表示されます。

注意

setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupLogError を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー setupapi.h
Library Setupapi.lib
[DLL] Setupapi.dll
API セット ext-ms-win-setupapi-logging-l1-1-0 (Windows 8 で導入)

関連項目

関数

概要