GetDescription

The GetDescription and GetDescriptionWide methods return the description of a register.

HRESULT
  IDebugRegisters::GetDescription(
    IN ULONG  Register
    OUT OPTIONAL PSTR  NameBuffer,
    IN ULONG  NameBufferSize,
    OUT OPTIONAL PULONG  NameSize,
    OUT OPTIONAL PDEBUG_REGISTER_DESCRIPTION Desc
    );

HRESULT
  IDebugRegisters2::GetDescriptionWide(
    IN ULONG  Register
    OUT OPTIONAL PWSTR  NameBuffer,
    IN ULONG  NameBufferSize,
    OUT OPTIONAL PULONG  NameSize,
    OUT OPTIONAL PDEBUG_REGISTER_DESCRIPTION Desc
    );

#ifdef UNICODE
#define GetDescriptionT GetDescriptionWide
#else
#define GetDescriptionT GetDescription
#endif

Parameters

Register

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

NameBuffer

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

NameBufferSize

Specifies the size, in characters, of the buffer that NameBuffer specifies.

NameSize

Receives the size, in characters, of the register's name in NameBuffer buffer. If NameSize is NULL, this information is not returned.

Desc

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

Return Value

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.

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

Interface Version

GetDescription is available in all versions of IDebugRegisters. GetDescriptionWide is available in IDebugRegisters2 and later versions.

Comments

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

Requirements

Headers: Defined in DbgEng.h. Include DbgEng.h.