IDebugSymbols3::GetConstantName method (dbgeng.h)

Article
02/22/2024

The GetConstantName method returns the name of the specified constant.

Syntax

HRESULT GetConstantName(
  [in]            ULONG64 Module,
  [in]            ULONG   TypeId,
  [in]            ULONG64 Value,
  [out, optional] PSTR    NameBuffer,
  [in]            ULONG   NameBufferSize,
  [out, optional] PULONG  NameSize
);

Parameters

[in] Module

Specifies the base address of the module in which the constant was defined.

[in] TypeId

Specifies the type ID of the constant.

[in] Value

Specifies the value of the constant.

[out, optional] NameBuffer

Receives the constant's name. 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 constant's name. This size includes the space for the '\0' terminating character.

Return value

Return code	Description
S_OK	The method was successful.
S_FALSE	The method was successful. However, the buffer was not large enough for the constant's name and it was truncated.

This method can also return error values. For more information, see Return Values.

Remarks

For more information about symbols, see Symbols.

Requirements

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

Share via