Поделиться через


Метод IDebugRegisters2::GetDescription (dbgeng.h)

Метод GetDescription возвращает описание регистра.

Синтаксис

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

Параметры

[in] Register

Указывает индекс регистра, для которого запрашивается описание.

[out, optional] NameBuffer

Указывает буфер, в котором будет храниться имя регистра. Если NameBuffer имеет значение NULL, эти сведения не возвращаются.

[in] NameBufferSize

Задает размер буфера в символах, который задает NameBuffer . Этот размер включает пробел для завершающего символа "\0".

[out, optional] NameSize

Получает размер (в символах) имени регистра в буфере NameBuffer . Этот размер включает пробел для завершающего символа "\0". Если параметр NameSize имеет значение NULL, эти сведения не возвращаются.

[out, optional] Desc

Получает описание регистра. Дополнительные сведения см. в разделе DEBUG_REGISTER_DESCRIPTION .

Возвращаемое значение

Этот список не содержит всех ошибок, которые могут возникнуть. Список возможных ошибок см. в разделе Значения HRESULT.

Код возврата Описание
S_OK
Метод выполнен успешно.
S_FALSE
Метод выполнен успешно. Однако буфер был недостаточно велик для хранения имени регистра, поэтому он был усечен.
E_UNEXPECTED
Целевой компьютер не указан, или не удалось найти описание регистра.
E_INVALIDARG
Индекс запрошенного регистра превышает общее количество регистров на целевом компьютере.

Комментарии

Общие сведения об интерфейсе IDebugRegisters и других методах , связанных с регистрами, см. в разделе Registers.

Требования

Требование Значение
Целевая платформа Персональный компьютер
Верхняя часть dbgeng.h (включая DbgEng.h)