IDebugClient5::GetRunningProcessDescriptionWide-Methode (dbgeng.h)

Artikel
02/26/2024

Die GetRunningProcessDescriptionWide-Methode gibt eine Beschreibung des Prozesses zurück, die den Namen des ausführbaren Images, die Dienstnamen, die MTS-Paketnamen und die Befehlszeile enthält.

Syntax

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

Parameter

[in] Server

Gibt den Prozessserver an, auf dem die Prozessbeschreibung abfragt werden soll. Wenn Server 0 ist, fragt die Engine Informationen zum lokalen Prozess direkt ab.

[in] SystemId

Gibt die Prozess-ID des Prozesses an, dessen Beschreibung erwünscht ist.

[in] Flags

Gibt einen Bitsatz an, der Optionen enthält, die das Verhalten dieser Methode beeinflussen. Flags können die folgenden Bitflags enthalten:

Flag	Beschreibung
DEBUG_PROC_DESC_NO_PATHS	Gibt nur Dateinamen ohne Pfadnamen zurück.
DEBUG_PROC_DESC_NO_SERVICES	Suchen Sie keine Dienstnamen.
DEBUG_PROC_DESC_NO_MTS_PACKAGES	Suchen Sie keine MTS-Paketnamen.
DEBUG_PROC_DESC_NO_COMMAND_LINE	Rufen Sie die Befehlszeile nicht ab.

[out, optional] ExeName

Empfängt den Namen der ausführbaren Datei, die zum Starten des Prozesses verwendet wird. Wenn ExeNameNULL ist, werden diese Informationen nicht zurückgegeben.

[in] ExeNameSize

Gibt die Größe des Puffers ExeNameSize in Zeichen an. Diese Größe enthält den Platz für das "\0"-Endzeichen.

[out, optional] ActualExeNameSize

Empfängt die Größe des ausführbaren Dateinamens in Zeichen. Diese Größe enthält den Platz für das "\0"-Endzeichen. Wenn ExeNameSizeNULL ist, werden diese Informationen nicht zurückgegeben.

[out, optional] Description

Empfängt zusätzliche Informationen zum Prozess, einschließlich Dienstnamen, MTS-Paketnamen und der Befehlszeile. Wenn DescriptionNULL ist, werden diese Informationen nicht zurückgegeben.

[in] DescriptionSize

Gibt die Größe der Pufferbeschreibung in Zeichen an. Diese Größe enthält den Platz für das "\0"-Endzeichen.

[out, optional] ActualDescriptionSize

Empfängt die Größe der zusätzlichen Informationen in Zeichen. Diese Größe enthält den Platz für das "\0"-Endzeichen. Wenn ActualDescriptionSizeNULL ist, werden diese Informationen nicht zurückgegeben.

Rückgabewert

Diese Methode kann auch Fehlerwerte zurückgeben. Weitere Informationen finden Sie unter Rückgabewerte .

Rückgabecode	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
S_FALSE	Die Methode war erfolgreich. Entweder ExeNameSize oder DescriptionSize waren jedoch kleiner als die Größe der jeweiligen Zeichenfolge, und die Zeichenfolge wurde abgeschnitten, um in den Puffer zu passen.