Método IDebugRegisters2::GetPseudoDescription (dbgeng.h)

Artigo
02/26/2024

O método GetPseudoDescription retorna uma descrição de um pseudo-registro, incluindo seu nome e tipo.

Sintaxe

HRESULT GetPseudoDescription(
  [in]            ULONG    Register,
  [out, optional] PSTR     NameBuffer,
  [in]            ULONG    NameBufferSize,
  [out, optional] PULONG   NameSize,
  [out, optional] PULONG64 TypeModule,
  [out, optional] PULONG   TypeId
);

Parâmetros

[in] Register

Especifica o índice do pseudo-registro cuja descrição é solicitada. O índice está sempre entre zero e o número de pseudoregistros (retornados por GetNumberPseudoRegisters) menos um.

[out, optional] NameBuffer

Recebe o nome do pseudo-registro. Se NameBuffer for NULL, essas informações não serão retornadas.

[in] NameBufferSize

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

[out, optional] NameSize

Recebe o tamanho em caracteres do nome do pseudo-registro. Esse tamanho inclui o espaço para o caractere de terminação '\0'. Se NameSize for NULL, essas informações não serão retornadas.

[out, optional] TypeModule

Recebe o endereço base do módulo ao qual o tipo do registro pertence. Se o tipo do registro não for conhecido, zero será retornado. Se TypeModule for NULL, nenhuma informação será retornada.

[out, optional] TypeId

Recebe a ID de tipo do tipo dentro do módulo retornado em TypeModule. Se a ID do tipo não for conhecida, zero será retornado. Se TypeId for NULL, nenhuma informação será retornada.

Retornar valor

Essa lista não contém todos os erros que podem ocorrer. Para obter uma lista de possíveis erros, consulte Valores HRESULT.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
E_FAIL	A descrição do registro não estava disponível

Comentários

As descrições nem sempre estão disponíveis para todos os registros. Se um pseudo-registro não tiver um valor , por exemplo, $eventip não terá um valor antes de ocorrer um evento – ou um tipo não pode ser determinado para um pseudo-registro, esse método retornará E_FAIL.

Para obter uma visão geral da interface IDebugRegisters e outros métodos relacionados ao registro, consulte Registros.