IVsBuildableProjectCfg.AdviseBuildStatusCallback Method

Article
03/06/2013

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

'Declaration
Function AdviseBuildStatusCallback ( _
    pIVsBuildStatusCallback As IVsBuildStatusCallback, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer

int AdviseBuildStatusCallback(
    IVsBuildStatusCallback pIVsBuildStatusCallback,
    out uint pdwCookie
)

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

abstract AdviseBuildStatusCallback : 
        pIVsBuildStatusCallback:IVsBuildStatusCallback * 
        pdwCookie:uint32 byref -> int

function AdviseBuildStatusCallback(
    pIVsBuildStatusCallback : IVsBuildStatusCallback, 
    pdwCookie : uint
) : int

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:

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.

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