IVsObjectList.GetText(UInt32, VSTREETEXTOPTIONS, String) Метод

Определение

Возвращает указатель на текстовое представления для запрошенного элемента списка дерева.

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

Параметры

index
UInt32

[in] Определяет отсчитываемый от нуля индекс элемента, представляющего интерес.

tto
VSTREETEXTOPTIONS

[in] Определяет запрашиваемый тип текста. Значения берутся из перечисления VSTREETEXTOPTIONS.

ppszText
String

[out] Указатель на текстовую строку из указанного элемента списка дерева. Разработчики должны выделить эту строку и сохранить указатель действительным в соответствии с примечаниями ниже.

Возвращаемое значение

Int32

Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.

Реализации

Комментарии

Подпись COM

Из всшелл. IDL:

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

Этот метод возвращает указатель на строку, содержащую различные текстовые элементы для элемента списка дерева. Указатели на строки, возвращаемые для, TTO_SORTTEXT должны оставаться допустимыми и неизменными на время существования списка, так как они используются для непрерывной сортировки и переупорядочения списка. Указатели строк для других VSTREETEXTOPTIONS значений перечисления должны оставаться неизменными до следующего GetText вызова, когда они могут быть удалены или использованы повторно.

Если вы реализуете IVsObjectList интерфейс в управляемом коде и вам нужна строка, удаленная вызывающим объектом, реализуйте IVsCoTaskMemFreeMyStrings интерфейс в IVsObjectList интерфейсе.

Применяется к