IVsTextMarkerClient.GetTipText Method

Article
05/06/2010

Returns the tip text for the text marker when the mouse hovers over the marker.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Déclaration
Function GetTipText ( _
    pMarker As IVsTextMarker, _
    <OutAttribute> pbstrText As String() _
) As Integer
'Utilisation
Dim instance As IVsTextMarkerClient
Dim pMarker As IVsTextMarker
Dim pbstrText As String()
Dim returnValue As Integer

returnValue = instance.GetTipText(pMarker, _
    pbstrText)

int GetTipText(
    IVsTextMarker pMarker,
    string[] pbstrText
)

int GetTipText(
    [InAttribute] IVsTextMarker^ pMarker, 
    [OutAttribute] array<String^>^ pbstrText
)

abstract GetTipText : 
        pMarker:IVsTextMarker * 
        pbstrText:string[] byref -> int

function GetTipText(
    pMarker : IVsTextMarker, 
    pbstrText : String[]
) : int

Parameters

pMarker
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextMarker
[in] Pointer to the IVsTextMarker interface for the marker.

pbstrText
Type: array<System.String[]
[out] Tip text associated with the marker.

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

HRESULT IVsTextMarkerClient::GetTipText(
   [in] IVsTextMarker* pMarker,
   [out, optional] BSTR *pbstrText
);

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