DefaultEvents.OnQueryCancel Method

This method is called at any juncture in task processing where it is feasible to cancel execution. This event is raised by tasks and containers to determine whether they should stop running.

Espace de noms: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntaxe

'Déclaration
Public Overridable Function OnQueryCancel As Boolean

public virtual bool OnQueryCancel ()

public:
virtual bool OnQueryCancel ()

public boolean OnQueryCancel ()

public function OnQueryCancel () : boolean

Valeur de retour

A Boolean that indicates if the task should stop running.

Notes

This event is called by the task to determine if the package wants the task to cease executing. Because the package gives control to the task to execute and does not terminate tasks randomly, there needs to be a juncture at which the package can inform the task that it is attempting to shut down. If the value is true, the task should shut down and DTSER_CANCELED is returned from the Execute method of the task. If the value is false, the task continues to run as usual.

Sécurité des threads

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Plateformes

Plateformes de développement

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Plateformes cibles

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Voir aussi

Référence

DefaultEvents Class
DefaultEvents Members
Microsoft.SqlServer.Dts.Runtime Namespace