IVsButtonBarClient.GetButtonTipText(Int32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the tooltip for a button

public:
 int GetButtonTipText(int iButton, [Runtime::InteropServices::Out] System::String ^ % pbstrTip);

int GetButtonTipText(int iButton, [Runtime::InteropServices::Out] std::wstring const & & pbstrTip);

public int GetButtonTipText (int iButton, out string pbstrTip);

abstract member GetButtonTipText : int * string -> int

Public Function GetButtonTipText (iButton As Integer, ByRef pbstrTip As String) As Integer

Parameters

iButton: Int32

[in] Number of the button for which to get the tooltip.

pbstrTip: String

[out] String containing the tooltip text.

Returns

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  
);

Applies to