IVsBuildableProjectCfg::AdviseBuildStatusCallback Method (IVsBuildStatusCallback^, UInt32)

Visual Studio 2015

Registers the environment to receive notifications of build status events.

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

Syntax

C++

int AdviseBuildStatusCallback(
	IVsBuildStatusCallback^ pIVsBuildStatusCallback,
	[OutAttribute] unsigned int% pdwCookie
)

Parameters

pIVsBuildStatusCallback: Type: Microsoft.VisualStudio.Shell.Interop::IVsBuildStatusCallback^
[in] Pointer to the environment's IVsBuildStatusCallback interface.

pdwCookie: Type: System::UInt32
[out] Pointer to an abstract handle that represents the completed registration.

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:

C++

HRESULT IVsBuildableProjectCfg::AdviseBuildStatusCallback(
   [in] IVsBuildStatusCallback *pIVsBuildStatusCallback,
   [out] VSCOOKIE *pdwCookie
);

The IVsBuildStatusCallback interface is the mechanism through which a project notifies the environment of changes to its build status. When a build event occurs, the project calls the appropriate IVsBuildStatusCallback method. For example, the project calls BuildEnd Method when a build is complete.