IDebugClient5::WriteDumpFile2 メソッド (dbgeng.h)

[アーティクル]
08/07/2023

WriteDumpFile2 メソッドは、ユーザーモードまたはカーネルモードのダンプファイルを作成します。

構文

HRESULT WriteDumpFile2(
  [in]           PCSTR DumpFile,
  [in]           ULONG Qualifier,
  [in]           ULONG FormatFlags,
  [in, optional] PCSTR Comment
);

パラメーター

[in] DumpFile

作成するダンプファイルの名前を指定します。 DumpFile には 、ファイル名拡張子を含める必要があります。 DumpFile には、相対パスまたは絶対パスを含めることができます。相対パスは、デバッガーが開始されたディレクトリに対する相対パスです。

[in] Qualifier

作成するダンプファイルの種類を指定します。使用可能な値については、「 DEBUG_DUMP_XXX」を参照してください。

[in] FormatFlags

ダンプファイルの形式を決定するフラグを指定し、ユーザーモードミニダンプの場合は --ファイルに含める情報を指定します。詳細については、「解説」を参照してください。

[in, optional] Comment

クラッシュダンプファイルに含めるコメント文字列を指定します。この文字列は、ダンプファイルが読み込まれるときにデバッガーコンソールに表示されます。一部のダンプファイル形式では、コメント文字列の格納がサポートされていません。

戻り値

このメソッドは、エラー値を返す場合もあります。詳細については、「戻り値」を参照してください。

リターンコード	説明
S_OK	メソッドは正常に実行されました。

注釈

DEBUG_FORMAT_XXX ビットフラグは 、WriteDumpFile2 および WriteDumpFileWide によって、クラッシュダンプファイルの形式と、ユーザーモードのミニダンプの場合、ファイルに含める情報を決定するために使用されます。

次のビットフラグは、すべてのクラッシュダンプファイルに適用されます。

値	説明
DEBUG_FORMAT_WRITE_CAB	クラッシュダンプファイルを CAB ファイルにパッケージ化します。 CAB ファイルには、指定されたファイル名またはファイルハンドルが使用されます。クラッシュダンプは、CAB ファイルに移動される前に、最初に一時ファイルに作成されます。
DEBUG_FORMAT_CAB_SECONDARY_FILES	CAB ファイルに現在のシンボルとマップされたイメージを含めます。 DEBUG_FORMAT_WRITE_CABが設定されていない場合、このフラグは無視されます。
DEBUG_FORMAT_NO_OVERWRITE	既存のファイルを上書きしないでください。

ユーザーモードのミニダンプには、次のビットフラグを含めることもできます。

値	説明
DEBUG_FORMAT_USER_SMALL_FULL_MEMORY	完全メモリデータを追加します。ターゲットアプリケーションが所有するすべてのアクセス可能なコミット済みページが含まれます。
DEBUG_FORMAT_USER_SMALL_HANDLE_DATA	ターゲットアプリケーションに関連付けられているハンドルに関するデータを追加します。
DEBUG_FORMAT_USER_SMALL_UNLOADED_MODULES	アンロードされたモジュール情報を追加します。この情報は、Windows Server 2003 以降のバージョンの Windows でのみ使用できます。
DEBUG_FORMAT_USER_SMALL_INDIRECT_MEMORY	間接メモリを追加します。スタックまたはバッキングストア上のポインターによって参照されるアドレスを囲むメモリの小さな領域が含まれます。
DEBUG_FORMAT_USER_SMALL_DATA_SEGMENTS	実行可能イメージ内のすべてのデータセグメントを追加します。
DEBUG_FORMAT_USER_SMALL_FILTER_MEMORY	スタックトレースを再作成するのに役立たないバッキングストア内のスタック上のすべてのメモリをゼロに設定します。これにより、不要な情報を削除することで、ミニダンプの圧縮効率を高め、プライバシーを向上させることができます。
DEBUG_FORMAT_USER_SMALL_FILTER_PATHS	モジュールのパスを削除し、モジュール名のみを残します。これは、ディレクトリ構造 (ユーザーの名前が含まれている可能性があります) を非表示にしてプライバシーを保護する場合に便利です。
DEBUG_FORMAT_USER_SMALL_PROCESS_THREAD_DATA	プロセス環境ブロック (PEB) とスレッド環境ブロック (TEB) を追加します。このフラグは、スレッドとプロセスの Windows システム情報を提供するために使用できます。
DEBUG_FORMAT_USER_SMALL_PRIVATE_READ_WRITE_MEMORY	コミットされたすべてのプライベート読み取り/書き込みメモリページを追加します。
DEBUG_FORMAT_USER_SMALL_NO_OPTIONAL_DATA	プライバシーに依存するデータがミニダンプに含まれないようにします。現在、このフラグは、次のフラグが設定されているために追加されたミニダンプデータから除外されます。 DEBUG_FORMAT_USER_SMALL_PROCESS_THREAD_DATA、 DEBUG_FORMAT_USER_SMALL_FULL_MEMORY、 DEBUG_FORMAT_USER_SMALL_INDIRECT_MEMORY、 DEBUG_FORMAT_USER_SMALL_PRIVATE_READ_WRITE_MEMORY。
DEBUG_FORMAT_USER_SMALL_FULL_MEMORY_INFO	すべての基本的なメモリ情報を追加します。これは QueryVirtual メソッドによって返される情報です。有効なメモリだけでなく、すべてのメモリの情報が含まれています。これにより、デバッガーはミニダンプから完全な仮想メモリレイアウトを再構築できます。
DEBUG_FORMAT_USER_SMALL_THREAD_INFO	実行時間、開始時刻、終了時刻、開始アドレス、終了状態など、スレッド情報を追加します。
DEBUG_FORMAT_USER_SMALL_CODE_SEGMENTS	実行可能イメージを使用して、すべてのコードセグメントを追加します。