Método IDebugControl3::GetTextReplacement (dbgeng.h)

Artigo
02/23/2024

O método GetTextReplacement retorna o valor de um alias chamado pelo usuário ou de um alias automático.

Sintaxe

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
);

Parâmetros

[in, optional] SrcText

Especifica o nome do alias. O mecanismo pesquisa primeiro os aliases nomeados pelo usuário para um com esse nome. Em seguida, se nenhuma correspondência for encontrada, os aliases automáticos serão pesquisados. Se SrcText for NULL, Index será usado para especificar o alias.

[in] Index

Especifica o índice de um alias. Os índices dos aliases nomeados pelo usuário vêm antes dos índices dos aliases automáticos. O índice só será usado se SrcText for NULL. O índice pode ser usado junto com GetNumberTextReplacements para iterar em todos os aliases nomeados pelo usuário e automáticos.

[out, optional] SrcBuffer

Recebe o nome do alias. Esse é o nome especificado em SrcText, se SrcText não for NULL. Se SrcBuffer for NULL, essas informações não serão retornadas.

[in] SrcBufferSize

Especifica o tamanho, em caracteres, do buffer SrcBuffer .

[out, optional] SrcSize

Recebe o tamanho, em caracteres, do nome do alias. Se SrcSize for NULL, essas informações não serão retornadas.

[out, optional] DstBuffer

Recebe o valor do alias especificado por SrcText e Index. Se DstBuffer for NULL, essas informações não serão retornadas.

[in] DstBufferSize

Especifica o tamanho, em caracteres, do buffer DstBuffer .

[out, optional] DstSize

Recebe o tamanho, em caracteres, do valor do alias. Se DstSize for NULL, essas informações não serão retornadas.

Retornar valor

Esse método também pode retornar valores de erro. Consulte Valores retornados para obter mais detalhes.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.

Comentários

Antes de executar comandos ou avaliar expressões, o mecanismo de depurador substituirá o alias especificado por SrcBuffer pelo valor do alias (especificado por DstBuffer).

Para obter uma visão geral dos aliases usados pelo mecanismo de depurador, consulte Usando aliases. Para obter mais informações sobre como usar aliases com a API do mecanismo de depurador, consulte Interação com o Mecanismo.