IVsSimplePreviewChangesList.GetTipTextWithOwnership Method

Article
2013-03-06

Returns the ToolTip 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 GetTipTextWithOwnership ( _
    index As UInteger, _
    eTipType As VSTREETOOLTIPTYPE, _
    <OutAttribute> ByRef pbstrText As String _
) As Integer

int GetTipTextWithOwnership(
    uint index,
    VSTREETOOLTIPTYPE eTipType,
    out string pbstrText
)

int GetTipTextWithOwnership(
    [InAttribute] unsigned int index, 
    [InAttribute] VSTREETOOLTIPTYPE eTipType, 
    [OutAttribute] String^% pbstrText
)

abstract GetTipTextWithOwnership : 
        index:uint32 * 
        eTipType:VSTREETOOLTIPTYPE * 
        pbstrText:string byref -> int

function GetTipTextWithOwnership(
    index : uint, 
    eTipType : VSTREETOOLTIPTYPE, 
    pbstrText : String
) : int

Parameters

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

eTipType
Type: Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE
[in] A value from the VSTREETOOLTIPTYPE enumeration specifying the kind of ToolTip text to return.

pbstrText
Type: System.String%
[out] Returns a string containing the ToolTip text.

Return Value

Type: System.Int32
f the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsSimplePreviewChangesList::GetTipTextWithOwnership(
   [in]  ULONG               Index, 
   [in]  VSTREETOOLTIPTYPE   eTipType, 
   [out] BSTR               *ppszText
);

.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