Método IDebugClient5::GetRunningProcessDescriptionWide (dbgeng.h)

Artigo
02/23/2024

O método GetRunningProcessDescriptionWide retorna uma descrição do processo que inclui o nome da imagem executável, os nomes de serviço, os nomes de pacote mts e a linha de comando.

Sintaxe

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
);

Parâmetros

[in] Server

Especifica o servidor de processo a ser consultado para a descrição do processo. Se Server for zero, o mecanismo consultará informações sobre o processo local diretamente.

[in] SystemId

Especifica a ID do processo cuja descrição é desejada.

[in] Flags

Especifica um conjunto de bits que contém opções que afetam o comportamento desse método. Os sinalizadores podem conter os seguintes sinalizadores de bit:

Sinalizador	Descrição
DEBUG_PROC_DESC_NO_PATHS	Retornar somente nomes de arquivo sem nomes de caminho.
DEBUG_PROC_DESC_NO_SERVICES	Não procure nomes de serviço.
DEBUG_PROC_DESC_NO_MTS_PACKAGES	Não procure nomes de pacote mts.
DEBUG_PROC_DESC_NO_COMMAND_LINE	Não recupere a linha de comando.

[out, optional] ExeName

Recebe o nome do arquivo executável usado para iniciar o processo. Se ExeName for NULL, essas informações não serão retornadas.

[in] ExeNameSize

Especifica o tamanho em caracteres do buffer ExeNameSize. Esse tamanho inclui o espaço para o caractere de terminação '\0'.

[out, optional] ActualExeNameSize

Recebe o tamanho em caracteres do nome do arquivo executável. Esse tamanho inclui o espaço para o caractere de terminação '\0'. Se ExeNameSize for NULL, essas informações não serão retornadas.

[out, optional] Description

Recebe informações extras sobre o processo, incluindo nomes de serviço, nomes de pacote MTS e a linha de comando. Se Description for NULL, essas informações não serão retornadas.

[in] DescriptionSize

Especifica o tamanho em caracteres da Descrição do buffer. Esse tamanho inclui o espaço para o caractere de terminação '\0'.

[out, optional] ActualDescriptionSize

Recebe o tamanho em caracteres das informações extras. Esse tamanho inclui o espaço para o caractere de terminação '\0'. Se ActualDescriptionSize for NULL, essas informações não serão retornadas.

Retornar valor

Esse método também pode retornar valores de erro. Consulte Valores retornados para obter mais detalhes.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
S_FALSE	O método foi bem-sucedido. No entanto, ExeNameSize ou DescriptionSize foram menores que o tamanho da respectiva cadeia de caracteres e a cadeia de caracteres foi truncada para caber dentro do buffer.