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

El método getDescription de devuelve la descripción de un registro.

Sintaxis

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 el índice del registro para el que se solicita la descripción.

[out, optional] NameBuffer

Especifica el búfer en el que se va a almacenar el nombre del registro. Si NameBuffer es null, no se devuelve esta información.

[in] NameBufferSize

Especifica el tamaño, en caracteres, del búfer que NameBuffer. Este tamaño incluye el espacio para el carácter de terminación '\0'.

[out, optional] NameSize

Recibe el tamaño, en caracteres, del nombre del registro en búfer nameBuffer. Este tamaño incluye el espacio para el carácter de terminación '\0'. Si NameSize es null, no se devuelve esta información.

[out, optional] Desc

Recibe la descripción del registro. Consulte DEBUG_REGISTER_DESCRIPTION para obtener más información.

Valor devuelto

Esta lista no contiene todos los errores que pueden producirse. Para obtener una lista de posibles errores, consulte valores HRESULT.

Código devuelto	Descripción
S_OK	El método se realizó correctamente.
S_FALSE	El método se realizó correctamente. Sin embargo, el búfer no era lo suficientemente grande como para contener el nombre del registro, por lo que se truncaba.
E_UNEXPECTED	No se ha especificado ninguna máquina de destino o no se encontró una descripción del registro.
E_INVALIDARG	El índice del registro solicitado es mayor que el número total de registros en la máquina del destino.

Observaciones

Para obtener información general sobre la interfaz de IDebugRegisters y otros métodos relacionados con el registro, consulte Registers.

Requisitos

Requisito	Valor
de la plataforma de destino de	Escritorio
encabezado de	dbgeng.h (include DbgEng.h)