Share via


IVsButtonBarClient.GetButtonTipText(Int32, String) Method

Definition

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

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