IVsOutputWindow.CreatePane(Guid, String, Int32, Int32) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Creates an output window pane.

public:
 int CreatePane(Guid % rguidPane, System::String ^ pszPaneName, int fInitVisible, int fClearWithSolution);

public int CreatePane (ref Guid rguidPane, string pszPaneName, int fInitVisible, int fClearWithSolution);

abstract member CreatePane : Guid * string * int * int -> int

Public Function CreatePane (ByRef rguidPane As Guid, pszPaneName As String, fInitVisible As Integer, fClearWithSolution As Integer) As Integer

Parameters

rguidPane

Guid

[in] GUID of the Output window pane.

pszPaneName

String

[in] Name of the output window pane.

fInitVisible

Int32

[in] If true, the output window pane is initially visible

fClearWithSolution

Int32

[in] If true, the output window pane is cleared when the solution closes.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsOutputWindow::CreatePane(  
   [in] REFGUID rguidPane,  
   [in] LPCOLESTR pszPaneName,  
   [in] BOOL fInitVisible,  
   [in] BOOL fClearWithSolution  
);  

The Build and the General output window panes are supplied by the environment. The Build output window pane is created by the SVsSolutionBuildManager service and the pointer to the Build window pane is passed to the projects as part of IVsBuildableProjectCfg operations. The General output window pane is a shared pane, which and is created and managed by the environment. It can be retrieved by calling QueryService(SID_SVsGeneralOutputWindowPane, and IID_IVsOutputWindowPane). To create your own output window, call CreatePane passing in the name and GUID you want to use for your custom output window pane.