IVsCompletionSet.GetDisplayText(Int32, String, Int32[]) Método

Definição

Retorna o texto de um item de conjunto de conclusão como ele aparece na lista conjunto de conclusão.

int GetDisplayText(int iIndex, [Runtime::InteropServices::Out] std::wstring const & & ppszText, std::Array <int> const & piGlyph);
public int GetDisplayText (int iIndex, out string ppszText, int[] piGlyph);
abstract member GetDisplayText : int * string * int[] -> int
Public Function GetDisplayText (iIndex As Integer, ByRef ppszText As String, Optional piGlyph As Integer()) As Integer

Parâmetros

iIndex
Int32

no Índice do item do conjunto de conclusão para o qual retornar o texto de exibição.

ppszText
String

fora Retorna uma cadeia de caracteres que contém o texto de exibição.

piGlyph
Int32[]

fora Retorna um inteiro que identifica o glifo a ser exibido ao lado do item de conclusão.

Retornos

Int32

Se o método for bem-sucedido, retornará S_OK. Se falhar, retornará um código de erro.

Comentários

Assinatura COM

De textmgr. idl:

HRESULT IVsCompletionSet::GetDisplayText(  
   [in] long iIndex,  
   [out] WCHAR **ppszText,  
   [out, optional] long *piGlyph  
);  

A cadeia de caracteres retornada deve ser mantida pelo objeto Set de conclusão, e a cadeia de caracteres deve permanecer válida até a versão final ou até ser atualizada chamando UpdateCompletionStatus . GetImageList é usado pela exibição para determinar a lista de imagens associadas a um conjunto de conclusão.

Observação

A cadeia de caracteres é normalmente criada pelo objeto do conjunto de conclusão e a cadeia de caracteres deve persistir durante o ciclo de vida desse objeto ou até que o Dismiss método seja chamado.

Se você estiver implementando essa interface em código gerenciado e precisar ter a cadeia de caracteres descartada pelo chamador, implemente a IVsCoTaskMemFreeMyStrings interface.

Aplica-se a