GetIndexByName

The GetIndexByName method returns the index of the named register.

HRESULT
  IDebugRegisters::GetIndexByName(
    IN PCSTR  Name,
    OUT PULONG  Index
    );

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

#ifdef UNICODE
#define GetIndexByNameT GetIndexByNameWide
#else
#define GetIndexByNameT GetIndexByName
#endif

Parameters

Name

Specifies the name of the register whose index is requested.

Index

Receives the index of the register.

Return Value

S_OK

The method was successful.

E_NOINTERFACE

The register was not found.

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

Interface Version

GetIndexByName is available in all versions of IDebugRegisters. GetIndexByNameWide 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.