IVsButtonBarClient.GetButtonTipText Method

Returns the tooltip for a button

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

Syntax

'Declaration
Function GetButtonTipText ( _
    iButton As Integer, _
    <OutAttribute> ByRef pbstrTip As String _
) As Integer
'Usage
Dim instance As IVsButtonBarClient
Dim iButton As Integer
Dim pbstrTip As String
Dim returnValue As Integer

returnValue = instance.GetButtonTipText(iButton, _
    pbstrTip)

int GetButtonTipText(
    int iButton,
    out string pbstrTip
)

int GetButtonTipText(
    [InAttribute] int iButton, 
    [OutAttribute] String^% pbstrTip
)

abstract GetButtonTipText : 
        iButton:int * 
        pbstrTip:string byref -> int

function GetButtonTipText(
    iButton : int, 
    pbstrTip : String
) : int

Parameters

iButton
Type: System.Int32
[in]

pbstrTip
Type: System.String%
[out] String containing the tooltip text.

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 IVsButtonBarClient::GetButtonTipText(
   [in] long iButton,
   [out] BSTR *pbstrTip
);

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