IDebugClient5::GetRunningProcessDescription method (dbgeng.h)
The GetRunningProcessDescription method returns a description of the process that includes the executable image name, the service names, the MTS package names, and the command line.
Syntax
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
);
Parameters
[in] Server
Specifies the process server to query for the process description. If Server is zero, the engine will query information about the local process directly.
[in] SystemId
Specifies the process ID of the process whose description is desired.
[in] Flags
Specifies a bit-set containing options that affect the behavior of this method. Flags can contain the following bit flags:
| Flag | Description |
|---|---|
| DEBUG_PROC_DESC_NO_PATHS | Return only file names without path names. |
| DEBUG_PROC_DESC_NO_SERVICES | Do not look up service names. |
| DEBUG_PROC_DESC_NO_MTS_PACKAGES | Do not look up MTS package names. |
| DEBUG_PROC_DESC_NO_COMMAND_LINE | Do not retrieve the command line. |
[out, optional] ExeName
Receives the name of the executable file used to start the process. If ExeName is NULL, this information is not returned.
[in] ExeNameSize
Specifies the size in characters of the buffer ExeNameSize. This size includes the space for the '\0' terminating character.
[out, optional] ActualExeNameSize
Receives the size in characters of the executable file name. This size includes the space for the '\0' terminating character. If ExeNameSize is NULL, this information is not returned.
[out, optional] Description
Receives extra information about the process, including service names, MTS package names, and the command line. If Description is NULL, this information is not returned.
[in] DescriptionSize
Specifies the size in characters of the buffer Description. This size includes the space for the '\0' terminating character.
[out, optional] ActualDescriptionSize
Receives the size in characters of the extra information. This size includes the space for the '\0' terminating character. If ActualDescriptionSize is NULL, this information is not returned.
Return value
This method may also return error values. See Return Values for more details.
| Return code | Description |
|---|---|
|
The method was successful. |
|
The method was successful. However, either ExeNameSize or DescriptionSize were smaller than the size of the respective string and the string was truncated to fit inside the buffer. |
Remarks
This method is available only for live user-mode debugging.
For more information about creating and attaching to live user-mode targets, see Live User-Mode Targets.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Desktop |
| Header | dbgeng.h (include Dbgeng.h) |