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

GetRunningProcessDescription メソッドは、実行可能イメージ名、サービス名、MTS パッケージ名、およびコマンド ラインを含むプロセスの説明を返します。

構文

HRESULT GetRunningProcessDescription(
  [in]            ULONG64 Server,
  [in]            ULONG   SystemId,
  [in]            ULONG   Flags,
  [out, optional] PSTR    ExeName,
  [in]            ULONG   ExeNameSize,
  [out, optional] PULONG  ActualExeNameSize,
  [out, optional] PSTR    Description,
  [in]            ULONG   DescriptionSize,
  [out, optional] PULONG  ActualDescriptionSize
);

パラメーター

[in] Server

プロセスの説明を照会するプロセス サーバーを指定します。 サーバーが 0 の場合、エンジンはローカル プロセスに関する情報を直接照会します。

[in] SystemId

説明が必要なプロセスのプロセス ID を指定します。

[in] Flags

このメソッドの動作に影響を与えるオプションを含むビット セットを指定します。 フラグ には、次のビット フラグを含めることができます。

フラグ 説明
DEBUG_PROC_DESC_NO_PATHS パス名のないファイル名のみを返します。
DEBUG_PROC_DESC_NO_SERVICES サービス名を検索しないでください。
DEBUG_PROC_DESC_NO_MTS_PACKAGES MTS パッケージ名を検索しないでください。
DEBUG_PROC_DESC_NO_COMMAND_LINE コマンド ラインを取得しないでください。

[out, optional] ExeName

プロセスの開始に使用する実行可能ファイルの名前を受け取ります。 ExeNameNULL の場合、この情報は返されません。

[in] ExeNameSize

バッファー ExeNameSize のサイズを文字数で指定します。 このサイズには、'\0' 終端文字のスペースが含まれます。

[out, optional] ActualExeNameSize

実行可能ファイル名のサイズを文字数で受け取ります。 このサイズには、'\0' 終端文字のスペースが含まれます。 ExeNameSizeNULL の場合、この情報は返されません。

[out, optional] Description

サービス名、MTS パッケージ名、コマンド ラインなど、プロセスに関する追加情報を受け取ります。 DescriptionNULL の場合、この情報は返されません。

[in] DescriptionSize

バッファーの説明の文字数でサイズを指定 します。 このサイズには、'\0' 終端文字のスペースが含まれます。

[out, optional] ActualDescriptionSize

追加情報のサイズを文字数で受け取ります。 このサイズには、'\0' 終端文字のスペースが含まれます。 ActualDescriptionSizeNULL の場合、この情報は返されません。

戻り値

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

リターン コード 説明
S_OK
メソッドは正常に実行されました。
S_FALSE
メソッドは正常に実行されました。 ただし、 ExeNameSize または DescriptionSize のいずれかがそれぞれの文字列のサイズより小さく、文字列がバッファー内に収まるように切り捨てられました。

注釈

このメソッドは、ライブ ユーザー モードデバッグでのみ使用できます。

ライブ ユーザー モード ターゲットの作成とアタッチの詳細については、「 Live User-Mode Targets」を参照してください。

要件

要件
対象プラットフォーム デスクトップ
Header dbgeng.h (Dbgeng.h を含む)

こちらもご覧ください

AttachProcess

ConnectProcessServer

CreateProcessAndAttach2

GetRunningProcessSystemIdByExecutableName

GetRunningProcessSystemIds

IDebugClient

IDebugClient2

IDebugClient3

IDebugClient4

IDebugClient5