IVsButtonBarManager.GetButtonBar(IVsButtonBar) Method

Definition

Returns the button bar associated with a code window.

public:
 int GetButtonBar([Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsButtonBar ^ % ppButtonBar);
public:
 int GetButtonBar([Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsButtonBar ^ &  ppButtonBar);
int GetButtonBar([Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::IVsButtonBar const & & ppButtonBar);
public int GetButtonBar (out Microsoft.VisualStudio.TextManager.Interop.IVsButtonBar ppButtonBar);
abstract member GetButtonBar : IVsButtonBar -> int
Public Function GetButtonBar (ByRef ppButtonBar As IVsButtonBar) As Integer

Parameters

ppButtonBar
IVsButtonBar

[out] Pointer to a button bar.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsButtonBarManager::GetButtonBar(  
   [out] IVsButtonBar **ppButtonBar  
);  

GetButtonBar sends back the button bar associated with a code window, if any. If a button bar is associated with the window, GetButtonBar returns S_OK and sends back an AddRef'd pointer to the button bar. Otherwise it returns S_FALSE and sets ppButtonBar to null.

Applies to