IVsObjectList.GetText Method

Article
07/12/2014

Returns a pointer to the text representations for the requested tree list item.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.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: 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.

ppszText
Type: System.String%

[out] Pointer to a text string from the specified tree list item. Implementers must allocate this string and keep the pointer valid as per the remarks below.

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 vsshell.idl:

HRESULT IVsObjectList::GetText(
   [in] ULONG Index,
   [in] VSTREETEXTOPTIONS tto,
   [out] const WCHAR **ppszText
);

This method returns a pointer to a string containing various text elements for the tree list item. String pointers returned for TTO_SORTTEXT must remain valid and unchanged for the lifetime of the list as they are used to continually sort and resort the list. String pointers for other VSTREETEXTOPTIONS enumeration values only need to remain intact until the next GetText call, at which time they may be discarded or reused.

If you are implementing the IVsObjectList interface in managed code and you need to have the string disposed by the caller, implement the IVsCoTaskMemFreeMyStrings interface on the IVsObjectList interface.

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

Share via