IXtfConsoleControlClient::GenerateStackDump
スタック ダンプを生成します。構文
パラメーター
ProcessId型: UINT32 スタック ダンプの作成対象となるプロセスの識別子です。 DumpType
型: UINT32 作成するスタック ダンプの種類です。有効なダンプの種類は次のとおりです。
ImageName
型: LPCWSTR イメージの名前です。 FilePath
型: LPBSTR 作成されたスタック ダンプ ファイルへのファイル パスを受け取る文字列へのポインターです。
戻り値
型: HRESULT 成功した場合はS_OK を返します。それ以外の場合は HRESULT エラー コードを返します。関数がスタック ダンプの完了を待機してタイムアウトした場合、この関数は E_MESSAGE_TIMED_OUT を返します。
解説
この関数は、開発コンソール上の実行可能イメージについて、指定したプロセスからスタック ダンプを生成します。スタック ダンプは、コンソールのスクラッチ ドライブ上に、FilePath で返されるファイル パスにファイルとして保存されます。
スタック ダンプによって取得される情報と、その情報の取得にかかる時間は、DumpType で指定するダンプの種類によって異なります。この関数は 5 分後にタイムアウトします。関数がタイムアウトする前にコンソールからスタック ダンプが返されなかった場合、この関数は E_MESSAGE_TIMED_OUT を返します。次の表に、各スタック ダンプの種類で返される情報を示します。
XBOX Tools Framework (XTF) などの利用可能なツールおよび自動化 API の詳細については、Tool and automation APIs (NDA topic) を参照してください。
LPBSTR ポインターの取り扱い
この関数が返す LPBSTR ポインターの取り扱いについては、Allocating and Releasing Memory for a BSTR を参照してください。要件
ヘッダー: xtfconsolecontrol.h ライブラリ: xtfconsolecontrol.lib サポートされるプラットフォーム: Windows (XBOX コンソール ツール用)関連項目
XtfConsoleControlXBOX Tools Framework
