IVsObjectList.GetText(UInt32, VSTREETEXTOPTIONS, String) Método

Definição

Retorna um ponteiro para as representações de texto do item de lista de árvore solicitado.

public:
 int GetText(System::UInt32 index, Microsoft::VisualStudio::Shell::Interop::VSTREETEXTOPTIONS tto, [Runtime::InteropServices::Out] System::String ^ % ppszText);
int GetText(unsigned int index, Microsoft::VisualStudio::Shell::Interop::VSTREETEXTOPTIONS tto, [Runtime::InteropServices::Out] std::wstring const & & ppszText);
public int GetText (uint index, Microsoft.VisualStudio.Shell.Interop.VSTREETEXTOPTIONS tto, out string ppszText);
abstract member GetText : uint32 * Microsoft.VisualStudio.Shell.Interop.VSTREETEXTOPTIONS * string -> int
Public Function GetText (index As UInteger, tto As VSTREETEXTOPTIONS, ByRef ppszText As String) As Integer

Parâmetros

index
UInt32

no Especifica o índice baseado em zero do item de interesse.

tto
VSTREETEXTOPTIONS

no Especifica o tipo de texto que está sendo solicitado. Os valores são obtidos da VSTREETEXTOPTIONS enumeração.

ppszText
String

fora Ponteiro para uma cadeia de texto do item de lista de árvore especificado. Os implementadores devem alocar essa cadeia de caracteres e manter o ponteiro válido de acordo com os comentários abaixo.

Retornos

Int32

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

Implementações

Comentários

Assinatura COM

De VSShell. idl:

HRESULT IVsObjectList::GetText(  
   [in] ULONG Index,  
   [in] VSTREETEXTOPTIONS tto,  
   [out] const WCHAR **ppszText  
);  

Esse método retorna um ponteiro para uma cadeia de caracteres que contém vários elementos de texto para o item de lista de árvore. Os ponteiros de cadeia de caracteres retornados para TTO_SORTTEXT devem permanecer válidos e inalterados durante o tempo de vida da lista, pois são usados para classificar e recorrer continuamente a lista. Os ponteiros de cadeia de caracteres para outros VSTREETEXTOPTIONS valores de enumeração só precisam permanecer intactos até a próxima GetText chamada, em que momento eles podem ser descartados ou reutilizados.

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

Aplica-se a