IVsSimpleObjectList2.GetTextWithOwnership Method

Article
03/06/2013

Returns the text representations for the requested tree list item.

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

Syntax

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

int GetTextWithOwnership(
    uint index,
    VSTREETEXTOPTIONS tto,
    out string pbstrText
)

int GetTextWithOwnership(
    [InAttribute] unsigned int index, 
    [InAttribute] VSTREETEXTOPTIONS tto, 
    [OutAttribute] String^% pbstrText
)

abstract GetTextWithOwnership : 
        index:uint32 * 
        tto:VSTREETEXTOPTIONS * 
        pbstrText:string byref -> int

function GetTextWithOwnership(
    index : uint, 
    tto : VSTREETEXTOPTIONS, 
    pbstrText : 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.

pbstrText
Type: System.String%
[out] Returns the text for the specified tree list item.

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:

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.

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