IVsDeployStatusCallback.OnStartDeploy Method

Notifies the environment that a deployment operation has begun.

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

Syntax

'Declaration
Function OnStartDeploy ( _
    <OutAttribute> ByRef pfContinue As Integer _
) As Integer
int OnStartDeploy(
    out int pfContinue
)
int OnStartDeploy(
    [InAttribute] [OutAttribute] int% pfContinue
)
abstract OnStartDeploy : 
        pfContinue:int byref -> int
function OnStartDeploy(
    pfContinue : int
) : int

Parameters

  • pfContinue
    Type: System.Int32%

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

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

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

.NET Framework Security

See Also

Reference

IVsDeployStatusCallback Interface

Microsoft.VisualStudio.Shell.Interop Namespace