IVsBuildStatusCallback.BuildBegin(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Notifies the environment that a build operation has begun.

public:
 int BuildBegin([Runtime::InteropServices::Out] int % pfContinue);

int BuildBegin([Runtime::InteropServices::Out] int & pfContinue);

public int BuildBegin (out int pfContinue);

abstract member BuildBegin : int -> int

Public Function BuildBegin (ByRef pfContinue As Integer) As Integer

Parameters

pfContinue: Int32

[in, out] Pointer to a flag that is set to true if the build process can continue and false if it should be terminated.

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 IVsBuildStatusCallback::BuildBegin(  
   [in, out] BOOL *pfContinue  
);

Projects call this method when they begin a build operation to alert the environment. The environment in turn can cancel the build by setting the contents of pfContinue to false.

Applies to