IVsPreviewChangesList.GetText Method

Article
04/29/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

'Declaration
Function GetText ( _
    index As UInteger, _
    tto As VSTREETEXTOPTIONS, _
    <OutAttribute> ByRef ppszText As String _
) As Integer

int GetText(
    uint index,
    VSTREETEXTOPTIONS tto,
    out string ppszText
)

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

abstract GetText : 
        index:uint32 * 
        tto:VSTREETEXTOPTIONS * 
        ppszText:string byref -> int

function GetText(
    index : uint, 
    tto : VSTREETEXTOPTIONS, 
    ppszText : String
) : int

Parameters

index
Type: 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: String%

[out] Returns a string containing the requested text.

Return Value

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via