IVsPreviewChangesList.GetText(UInt32, VSTREETEXTOPTIONS, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns the specified text for the specified item in the preview list.

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

Parameters

index

UInt32

[in] The index of the item for which to get text.

tto

VSTREETEXTOPTIONS

[in] A VSTREETEXTOPTIONS structure describing what kind of text to return.

ppszText

String

[out] Returns a string containing the requested text.

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 IVsPreviewChangesList::GetText(  
   [in]  ULONG              Index,   
   [in]  VSTREETEXTOPTIONS  tto,   
   [out] const WCHAR      **ppszText  
);  

Note that, for performance reasons, the returned string must persist for the life of the IVsPreviewChangesList object.