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

Registers the environment to receive notifications of build status events.

public:
 int AdviseBuildStatusCallback(Microsoft::VisualStudio::Shell::Interop::IVsBuildStatusCallback ^ pIVsBuildStatusCallback, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);

int AdviseBuildStatusCallback(Microsoft::VisualStudio::Shell::Interop::IVsBuildStatusCallback const & pIVsBuildStatusCallback, [Runtime::InteropServices::Out] unsigned int & pdwCookie);

public int AdviseBuildStatusCallback (Microsoft.VisualStudio.Shell.Interop.IVsBuildStatusCallback pIVsBuildStatusCallback, out uint pdwCookie);

abstract member AdviseBuildStatusCallback : Microsoft.VisualStudio.Shell.Interop.IVsBuildStatusCallback * uint32 -> int

Public Function AdviseBuildStatusCallback (pIVsBuildStatusCallback As IVsBuildStatusCallback, ByRef pdwCookie As UInteger) As Integer

Parameters

pIVsBuildStatusCallback: IVsBuildStatusCallback

[in] Pointer to the environment's IVsBuildStatusCallback interface.

pdwCookie: UInt32

[out] Pointer to an abstract handle that represents the completed registration.

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

Applies to