IVsSimpleObjectList2::GetTextWithOwnership Method (UInt32, VSTREETEXTOPTIONS, String^)

Visual Studio 2015

Returns the text representations for the requested tree list item.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

C++

int GetTextWithOwnership(
	unsigned int index,
	VSTREETEXTOPTIONS tto,
	[OutAttribute] String^% pbstrText
)

Parameters

index: Type: System::UInt32
[in] Specifies the zero based index of the item of interest.

tto: Type: Microsoft.VisualStudio.Shell.Interop::VSTREETEXTOPTIONS
[in] Specifies the text type being requested. Values are taken from the VSTREETEXTOPTIONS enumeration.

pbstrText: Type: System::String^
[out] Returns the text for the specified tree list item.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

C++

HRESULT IVsSimpleObjectList2::GetTextWithOwnership(
   [in]  ULONG              Index, 
   [in]  VSTREETEXTOPTIONS  tto, 
   [out] BSTR              *ppszText
);

This method returns a string containing various text elements for the tree list item.