IDebugSymbols3::GetNameByOffset method (dbgeng.h)

Article
02/22/2024

The GetNameByOffset method returns the name of the symbol at the specified location in the target's virtual address space.

Syntax

HRESULT GetNameByOffset(
  [in]            ULONG64  Offset,
  [out, optional] PSTR     NameBuffer,
  [in]            ULONG    NameBufferSize,
  [out, optional] PULONG   NameSize,
  [out, optional] PULONG64 Displacement
);

Parameters

[in] Offset

Specifies the location in the target's virtual address space of the symbol whose name is requested. Offset does not need to specify the base location of the symbol; it only needs to specify a location within the symbol's memory allocation.

[out, optional] NameBuffer

Receives the symbol's name. The name is qualified by the module to which the symbol belongs (for example, mymodule!main). If NameBuffer is NULL, this information is not returned.

[in] NameBufferSize

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

[out, optional] NameSize

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

[out, optional] Displacement

Receives the difference between the value of Offset and the base location of the symbol. If Displacement is NULL, this information is not returned.

Return value

This method may also return other error values. See Return Values for more details.

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 symbol's name, so it was truncated.
E_FAIL	No symbol could be found at the specified location.

Remarks

For more information about symbols and symbol names, see Symbols.

Requirements

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