IVsBuildableProjectCfg.StartClean Method

Requests that a project begin a clean operation, which is the process of deleting all of the outputs from the previous build.

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

Syntax

'Declaration
Function StartClean ( _
    pIVsOutputWindowPane As IVsOutputWindowPane, _
    dwOptions As UInteger _
) As Integer
'Usage
Dim instance As IVsBuildableProjectCfg
Dim pIVsOutputWindowPane As IVsOutputWindowPane
Dim dwOptions As UInteger
Dim returnValue As Integer

returnValue = instance.StartClean(pIVsOutputWindowPane, _
    dwOptions)

int StartClean(
    IVsOutputWindowPane pIVsOutputWindowPane,
    uint dwOptions
)

int StartClean(
    [InAttribute] IVsOutputWindowPane^ pIVsOutputWindowPane, 
    [InAttribute] unsigned int dwOptions
)

abstract StartClean : 
        pIVsOutputWindowPane:IVsOutputWindowPane * 
        dwOptions:uint32 -> int

function StartClean(
    pIVsOutputWindowPane : IVsOutputWindowPane, 
    dwOptions : uint
) : int

Parameters

pIVsOutputWindowPane
Type: Microsoft.VisualStudio.Shell.Interop.IVsOutputWindowPane
[in] Pointer to the IVsOutputWindowPane interface that can be used to display status during the clean operation.

dwOptions
Type: System.UInt32
[in] Options governing the clean operation. Currently, dwOptions is always zero.

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 IVsBuildableProjectCfg::StartClean(
   [in] IVsOutputWindowPane *pIVsOutputWindowPane,
   [in] DWORD dwOptions
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.