SetupLogFileA 関数 (setupapi.h)

  • [アーティクル]

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

SetupLogFile 関数は、ログ ファイルにエントリを追加します。

構文

WINSETUPAPI BOOL SetupLogFileA(
  [in] HSPFILELOG FileLogHandle,
  [in] PCSTR      LogSectionName,
  [in] PCSTR      SourceFilename,
  [in] PCSTR      TargetFilename,
  [in] DWORD      Checksum,
  [in] PCSTR      DiskTagfile,
  [in] PCSTR      DiskDescription,
  [in] PCSTR      OtherInfo,
  [in] DWORD      Flags
);

パラメーター

[in] FileLogHandle

SetupInitializeFileLog によって返されるファイル ログを処理します。 呼び出し元は、ログ ファイルが初期化されたときにSPFILELOG_QUERYONLYを渡していない必要があります。

[in] LogSectionName

ログ ファイル内の名前の論理グループの名前へのオプションのポインター。 null で終わる文字列を使用する必要があります。 ファイル ログの初期化時にSPFILELOG_SYSTEMLOGが渡されなかった場合は必須です。 それ以外の場合、このパラメーターは NULL にすることができます。

[in] SourceFilename

インストール元のソース メディアに存在するファイルの名前。 この名前は、呼び出し元にとって意味のある形式である必要があります。 null で終わる文字列を使用する必要があります。

[in] TargetFilename

ターゲットに存在するファイルの名前。 この名前は、呼び出し元にとって意味のある形式である必要があります。 null で終わる文字列を使用する必要があります。

[in] Checksum

チェックサム値への省略可能なポインター。 システム ログに必要です。

[in] DiskTagfile

ファイルがインストールされたメディアのタグファイルへのオプションのポインター。 null で終わる文字列を使用する必要があります。 null で終わる文字列は、宛先バッファーのサイズを超えてはなりません。 SPFILELOG_OEMFILEが指定されていない場合、システム ログでは無視されます。 SPFILELOG_OEMFILEが指定されている場合は、システム ログに必要です。 それ以外の場合、このパラメーターは NULL にすることができます。

[in] DiskDescription

ファイルがインストールされたメディアの人間が判読できる説明へのオプションのポインター。 null で終わる文字列を使用する必要があります。 flags パラメーターでSPFILELOG_OEMFILEが指定されていない場合、システム ログでは無視されます。 Flags パラメーターにSPFILELOG_OEMFILEが指定されている場合は、システム ログに必要です。 それ以外の場合、このパラメーターは NULL にすることができます。

[in] OtherInfo

ファイルに関連付ける追加情報へのオプションのポインター。 null で終わる文字列を使用する必要があります。 このパラメーターは、NULL でもかまいません。

[in] Flags

このパラメーターはSPFILELOG_OEMFILEできます。これはシステム ログに対してのみ意味があり、ファイルが Microsoft によって提供されていないことを示します。 このパラメーターは、OEM が Microsoft 提供のシステム ファイルを上書きする場合など、既存のファイルのエントリを変換するために使用できます。

戻り値

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

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

解説

注意

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

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー setupapi.h
Library Setupapi.lib
[DLL] Setupapi.dll

関連項目

関数

概要

SetupRemoveFileLogEntry