IVsSimpleObjectList2.GetTextWithOwnership Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the text representations for the requested tree list item.

public:
 int GetTextWithOwnership(System::UInt32 index, Microsoft::VisualStudio::Shell::Interop::VSTREETEXTOPTIONS tto, [Runtime::InteropServices::Out] System::String ^ % pbstrText);

int GetTextWithOwnership(unsigned int index, Microsoft::VisualStudio::Shell::Interop::VSTREETEXTOPTIONS tto, [Runtime::InteropServices::Out] std::wstring const & & pbstrText);

public int GetTextWithOwnership (uint index, Microsoft.VisualStudio.Shell.Interop.VSTREETEXTOPTIONS tto, out string pbstrText);

abstract member GetTextWithOwnership : uint32 * Microsoft.VisualStudio.Shell.Interop.VSTREETEXTOPTIONS * string -> int

Public Function GetTextWithOwnership (index As UInteger, tto As VSTREETEXTOPTIONS, ByRef pbstrText As String) As Integer

Parameters

index: UInt32

[in] Specifies the zero based index of the item of interest.

tto: VSTREETEXTOPTIONS

[in] Specifies the text type being requested. Values are taken from the VSTREETEXTOPTIONS enumeration.

pbstrText: String

[out] Returns the text for the specified tree list item.

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

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.

Applies to

Share via