Partager via


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
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] Number of the button for which to get the tooltip.

  • 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

See Also

Reference

IVsButtonBarClient Interface

Microsoft.VisualStudio.TextManager.Interop Namespace