IVsPreviewChangesList::GetText Method (UInt32, VSTREETEXTOPTIONS, String^)

Visual Studio 2015

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

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

Syntax

C++

int GetText(
	unsigned int index,
	VSTREETEXTOPTIONS tto,
	[OutAttribute] String^% ppszText
)

Parameters

index: Type: System::UInt32
[in] The index of the item for which to get text.

tto: Type: Microsoft.VisualStudio.Shell.Interop::VSTREETEXTOPTIONS
[in] A VSTREETEXTOPTIONS structure describing what kind of text to return.

ppszText: Type: System::String^
[out] Returns a string containing the requested text.

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 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.