IDebugRegisters2::GetDescription method (dbgeng.h)

Article
02/22/2024

The GetDescription method returns the description of a register.

Syntax

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

Parameters

[in] Register

Specifies the index of the register for which the description is requested.

[out, optional] NameBuffer

Specifies the buffer in which to store the name of the register. If NameBuffer is NULL, this information is not returned.

[in] NameBufferSize

Specifies the size, in characters, of the buffer that NameBuffer specifies. This size includes the space for the '\0' terminating character.

[out, optional] NameSize

Receives the size, in characters, of the register's name in NameBuffer buffer. This size includes the space for the '\0' terminating character. If NameSize is NULL, this information is not returned.

[out, optional] Desc

Receives the description of the register. See DEBUG_REGISTER_DESCRIPTION for more details.

Return value

This list does not contain all the errors that might occur. For a list of possible errors, see HRESULT Values.

Return code	Description
S_OK	The method was successful.
S_FALSE	The method was successful. However, the buffer was not large enough to hold the register's name, so it was truncated.
E_UNEXPECTED	No target machine has been specified, or a description of the register could not be found.
E_INVALIDARG	The index of the register requested is greater than the total number of registers on the target's machine.

Remarks

For an overview of the IDebugRegisters interface and other register-related methods, see Registers.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include DbgEng.h)

Share via