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

  • Artigo

O método GetDescription retorna a descrição de um registro.

Sintaxe

HRESULT GetDescription(
  [in]            ULONG                       Register,
  [out, optional] PSTR                        NameBuffer,
  [in]            ULONG                       NameBufferSize,
  [out, optional] PULONG                      NameSize,
  [out, optional] PDEBUG_REGISTER_DESCRIPTION Desc
);

Parâmetros

[in] Register

Especifica o índice do registro para o qual a descrição é solicitada.

[out, optional] NameBuffer

Especifica o buffer no qual armazenar o nome do registro. Se NameBuffer for NULL, essas informações não serão retornadas.

[in] NameBufferSize

Especifica o tamanho, em caracteres, do buffer especificado pelo 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 registro no buffer NameBuffer . 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] Desc

Recebe a descrição do registro. Consulte DEBUG_REGISTER_DESCRIPTION para obter mais detalhes.

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.
S_FALSE
 O método foi bem-sucedido. No entanto, o buffer não era grande o suficiente para manter o nome do registro, portanto, ele foi truncado.
E_UNEXPECTED
 Nenhum computador de destino foi especificado ou não foi possível encontrar uma descrição do registro.
E_INVALIDARG
 O índice do registro solicitado é maior que o número total de registros no computador do destino.

Comentários

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

Requisitos

Requisito Valor
Plataforma de Destino Área de Trabalho
Cabeçalho dbgeng.h (inclua DbgEng.h)