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 值。
返回代码 | 说明 |
---|---|
|
方法成功。 |
|
方法成功。 但是,缓冲区不够大,无法保存寄存器的名称,因此被截断。 |
|
未指定目标计算机,或者找不到寄存器的说明。 |
|
请求的寄存器的索引大于目标计算机上的寄存器总数。 |
注解
有关 IDebugRegisters 接口和其他寄存器相关方法的概述,请参阅 Registers。
要求
要求 | 值 |
---|---|
目标平台 | 桌面 |
标头 | dbgeng.h (包括 DbgEng.h) |