GetPseudoIndexByName

The GetPseudoIndexByName and GetPseudoIndexByNameWide methods return the index of a pseudo-register.

HRESULT
  IDebugRegisters2::GetPseudoIndexByName(
    IN PCSTR  Name,
    OUT PULONG  Index
    );

HRESULT
  IDebugRegisters2::GetPseudoIndexByNameWide(
    IN PCWSTR  Name,
    OUT PULONG  Index
    );

#ifdef UNICODE
#define GetPseudoIndexByNameT GetPseudoIndexByNameWide
#else
#define GetPseudoIndexByNameT GetPseudoIndexByName
#endif

Parameters

Name

Specifies the name of the pseudo-register whose index is requested. The name includes the leading dollar sign ( $ ), for example, "$frame".

Index

Receives the index of the pseudo-register.

Return Value

S_OK

The method was successful.

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

Interface Version

GetPseudoIndexByName and GetPseudoIndexByNameWide are available in IDebugRegisters2 and later versions.

Comments

For the names of all the pseudo-registers, see Pseudo-Register Syntax.

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

Requirements

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

See Also