IDebugControl2::GetTextMacro method (dbgeng.h)

Article
02/22/2024

The GetTextMacro method returns the value of a fixed-name alias.

Syntax

HRESULT GetTextMacro(
  [in]            ULONG  Slot,
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG MacroSize
);

Parameters

[in] Slot

Specifies the number of the fixed-name alias. Slot can take the values 0, 1, ..., 9, that represent the fixed-name aliases $u0, $u1, ..., $u9.

[out, optional] Buffer

Receives the value of the alias specified by Slot. If Buffer is NULL, this information is not returned.

[in] BufferSize

Specifies the size, in characters, of the Buffer buffer.

[out, optional] MacroSize

Receives the size, in characters, of the value of the alias.

Return value

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

Return code	Description
S_OK	The method was successful.

Remarks

Before executing commands or evaluating expressions, the debugger engine will replace the alias specified by Slot with the value of the alias (returned to the Buffer buffer).

For an overview of aliases used by the debugger engine, see Using Aliases. For more information about using aliases with the debugger engine API, see Interacting with the Engine.

Requirements

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