IVsOutputWindow.CreatePane Method

Creates an output window pane.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function CreatePane ( _
    ByRef rguidPane As Guid, _
    pszPaneName As String, _
    fInitVisible As Integer, _
    fClearWithSolution As Integer _
) As Integer
'Usage
Dim instance As IVsOutputWindow 
Dim rguidPane As Guid 
Dim pszPaneName As String 
Dim fInitVisible As Integer 
Dim fClearWithSolution As Integer 
Dim returnValue As Integer 

returnValue = instance.CreatePane(rguidPane, _
    pszPaneName, fInitVisible, fClearWithSolution)
int CreatePane(
    ref Guid rguidPane,
    string pszPaneName,
    int fInitVisible,
    int fClearWithSolution
)
int CreatePane(
    [InAttribute] Guid% rguidPane, 
    [InAttribute] String^ pszPaneName, 
    [InAttribute] int fInitVisible, 
    [InAttribute] int fClearWithSolution
)
function CreatePane(
    rguidPane : Guid, 
    pszPaneName : String, 
    fInitVisible : int, 
    fClearWithSolution : int
) : int

Parameters

  • rguidPane
    Type: System.Guid%

    [in] GUID of the Output window pane.

  • pszPaneName
    Type: System.String

    [in] Name of the output window pane.

  • fInitVisible
    Type: System.Int32

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

  • fClearWithSolution
    Type: System.Int32

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

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 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.

.NET Framework Security

See Also

Reference

IVsOutputWindow Interface

IVsOutputWindow Members

Microsoft.VisualStudio.Shell.Interop Namespace