MsiEnableLogA 関数 (msi.h)

  • [アーティクル]

MsiEnableLog 関数は、呼び出し元プロセスで開始されるすべての後続のインストールのログ モードを設定します。

構文

UINT MsiEnableLogA(
  [in] DWORD  dwLogMode,
  [in] LPCSTR szLogFile,
  [in] DWORD  dwLogAttributes
);

パラメーター

[in] dwLogMode

ログ モードを指定します。 このパラメーターには、次の 1 つ以上の値を指定できます。

値 意味
INSTALLLOGMODE_FATALEXIT
 メモリまたは致命的な終了情報をログアウトします。
INSTALLLOGMODE_ERROR
 エラー メッセージをログに記録します。
INSTALLLOGMODE_EXTRADEBUG
 ハンドル作成情報などの追加のデバッグ情報をログ ファイルに送信します。

Windows 2000 および Windows XP: この機能はサポートされていません。
INSTALLLOGMODE_WARNING
 警告メッセージをログに記録します。
INSTALLLOGMODE_USER
 ユーザー要求をログに記録します。
INSTALLLOGMODE_INFO
 表示されないステータス メッセージをログに記録します。
INSTALLLOGMODE_RESOLVESOURCE
 有効なソースの場所を決定するための要求。
INSTALLLOGMODE_OUTOFDISKSPACE
 ディスク領域が不足していることを示します。
INSTALLLOGMODE_ACTIONSTART
 新しいインストール アクションの開始をログに記録します。
INSTALLLOGMODE_ACTIONDATA
 インストール アクションを使用してデータ レコードをログに記録します。
INSTALLLOGMODE_COMMONDATA
 ユーザー インターフェイスの初期化のパラメーターをログに記録します。
INSTALLLOGMODE_PROPERTYDUMP
 終了時にプロパティ値をログに記録します。
INSTALLLOGMODE_VERBOSE
 INSTALLLOGMODE_EXTRADEBUGを除く他のすべてのログ モードで情報 をログに記録します。 これにより、ログ ファイルに大量の情報が送信され、一般にユーザーにとって役に立ちません。 テクニカル サポートに使用できます。
INSTALLLOGMODE_LOGONLYONERROR
 ログ情報は収集されますが、ログ ファイルに保存される頻度は低くなります。 これにより、一部のインストールのパフォーマンスが向上しますが、大規模なインストールにはほとんどメリットがない場合があります。 インストールが成功すると、ログ ファイルが削除されます。 インストールが失敗した場合、ログ情報はすべてログ ファイルに保存されます。

Windows インストーラー 2.0: このログ モードは使用できません。

[in] szLogFile

ログ ファイルへの完全パスを保持する文字列を指定します。 null を入力するとログ記録が無効になります。この場合、 dwlogmode は無視されます。 パスを指定する場合は、 dwlogmode を 0 にすることはできません。

[in] dwLogAttributes

ログ バッファーをフラッシュする頻度を指定します。

値 意味
INSTALLLOGATTRIBUTES_APPEND
 この値が設定されている場合、インストーラーは szLogFile で指定された既存のログを追加します。 設定されていない場合は、 szLogFile で指定された既存のログが上書きされます。
INSTALLLOGATTRIBUTES_FLUSHEACHLINE
 各行の後にログ バッファーを強制的にフラッシュします。 この値が設定されていない場合、インストーラーは FlushFileBuffers を呼び出して 20 行後にログ バッファーをフラッシュします。

戻り値

値 意味
ERROR_INVALID_PARAMETER
 無効なログ モードが指定されました。
ERROR_SUCCESS
 関数が正常に実行されました。

注釈

ログ ポリシーの説明については、「 システム ポリシー」を参照してください。

この関数を使用する場合は、ログ ファイルの場所へのパスが既に存在している必要があります。 インストーラーは、ログ ファイルのディレクトリ構造を作成しません。

注意

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

要件

   
サポートされている最小のクライアント Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 の Windows インストーラー 5.0。 Windows Server 2008 または Windows Vista の Windows インストーラー 4.0 または Windows インストーラー 4.5。 Windows Server 2003 または Windows XP の Windows インストーラー。 Windows インストーラーのバージョン別に必須となる最小 Windows サービス パックに関する詳細については、Windows インストーラーの実行時の要件に関する記事を参照してください。
対象プラットフォーム Windows
ヘッダー msi.h
Library Msi.lib
[DLL] Msi.dll

こちらもご覧ください

インターフェイス関数とログ関数

ログ