IVsBuildableProjectCfg.StartBuild Method

Article
02/04/2013

Requests that a project begin building.

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

Syntax

'Declaration
Function StartBuild ( _
    pIVsOutputWindowPane As IVsOutputWindowPane, _
    dwOptions As UInteger _
) As Integer

int StartBuild(
    IVsOutputWindowPane pIVsOutputWindowPane,
    uint dwOptions
)

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

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

function StartBuild(
    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 build operation.

dwOptions
Type: System.UInt32
[in] Options governing the build operation. The following options are valid:
VS_BUILDABLEPROJECTCFGOPTS_REBUILD
VS_BUILDABLEPROJECTCFGOPTS_BUILD_SELECTION_ONLY
VS_BUILDABLEPROJECTCFGOPTS_BUILD_ACTIVE_DOCUMENT_ONLY

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

The options defined for the dwOptions parameter are used to provide the project with information about the scope of the build. VS_BUILDABLEPROJECTCFGOPTS_REBUILD requests that the project rebuild completely regardless of whether it is up to date. VS_BUILDABLEPROJECTCFGOPTS_BUILD_SELECTION_ONLY requests that only the selected items be built. VS_BUILDABLEPROJECTCFGOPTS_BUILD_ACTIVE_DOCUMENT_ONLY requests that only the most recent document to be worked on be built.

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