IDebugControl3::GetTextReplacement method (dbgeng.h)
The GetTextReplacement method returns the value of a user-named alias or an automatic alias.
Syntax
HRESULT GetTextReplacement(
[in, optional] PCSTR SrcText,
[in] ULONG Index,
[out, optional] PSTR SrcBuffer,
[in] ULONG SrcBufferSize,
[out, optional] PULONG SrcSize,
[out, optional] PSTR DstBuffer,
[in] ULONG DstBufferSize,
[out, optional] PULONG DstSize
);
Parameters
[in, optional] SrcText
Specifies the name of the alias. The engine first searches the user-named aliases for one with this name. Then, if no match is found, the automatic aliases are searched. If SrcText is NULL, Index is used to specify the alias.
[in] Index
Specifies the index of an alias. The indexes of the user-named aliases come before the indexes of the automatic aliases. Index is only used if SrcText is NULL. Index can be used along with GetNumberTextReplacements to iterate over all the user-named and automatic aliases.
[out, optional] SrcBuffer
Receives the name of the alias. This is the name specified in SrcText, if SrcText is not NULL. If SrcBuffer is NULL, this information is not returned.
[in] SrcBufferSize
Specifies the size, in characters, of the SrcBuffer buffer.
[out, optional] SrcSize
Receives the size, in characters, of the name of the alias. If SrcSize is NULL, this information is not returned.
[out, optional] DstBuffer
Receives the value of the alias specified by SrcText and Index. If DstBuffer is NULL, this information is not returned.
[in] DstBufferSize
Specifies the size, in characters, of the DstBuffer buffer.
[out, optional] DstSize
Receives the size, in characters, of the value of the alias. If DstSize is NULL, this information is not returned.
Return value
This method may also return error values. See Return Values for more details.
| Return code | Description |
|---|---|
|
The method was successful. |
Remarks
Before executing commands or evaluating expressions, the debugger engine will replace the alias specified by SrcBuffer with the value of the alias (specified by DstBuffer).
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) |