| UID | title | description | old-location | tech.root | ms.date | keywords | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | f1_keywords | topic_type | api_type | api_location | api_name | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:dbgeng.IDebugControl3.GetTextReplacement |
IDebugControl3::GetTextReplacement (dbgeng.h) |
The GetTextReplacement method returns the value of a user-named alias or an automatic alias. This method belongs to the IDebugControl3 interface. |
debugger\gettextreplacement.htm |
debugger |
05/03/2018 |
|
GetTextReplacement, GetTextReplacement method [Windows Debugging], GetTextReplacement method [Windows Debugging],IDebugControl2 interface, GetTextReplacement method [Windows Debugging],IDebugControl3 interface, IDebugControl2 interface [Windows Debugging],GetTextReplacement method, IDebugControl2::GetTextReplacement, IDebugControl3 interface [Windows Debugging],GetTextReplacement method, IDebugControl3.GetTextReplacement, IDebugControl3::GetTextReplacement, IDebugControl_d21af006-aa5b-4faf-abba-3f28f338b6bd.xml, dbgeng/IDebugControl2::GetTextReplacement, dbgeng/IDebugControl3::GetTextReplacement, debugger.gettextreplacement |
dbgeng.h |
Dbgeng.h |
Desktop |
Windows |
|
|
|
|
|
The GetTextReplacement method returns the value of a user-named alias or an automatic alias.
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.
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.
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.
Specifies the size, in characters, of the SrcBuffer buffer.
Receives the size, in characters, of the name of the alias. If SrcSize is NULL, this information is not returned.
Receives the value of the alias specified by SrcText and Index. If DstBuffer is NULL, this information is not returned.
Specifies the size, in characters, of the DstBuffer buffer.
Receives the size, in characters, of the value of the alias. If DstSize is NULL, this information is not returned.
This method may also return error values. See Return Values for more details.
| Return code | Description |
|---|---|
|
The method was successful. |
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.