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

[アーティクル]
02/26/2024

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

プロセスの説明を照会するプロセスサーバーを指定します。 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

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

[in] ExeNameSize

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

[out, optional] ActualExeNameSize

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

[out, optional] Description

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

[in] DescriptionSize

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

[out, optional] ActualDescriptionSize

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

戻り値

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

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