ScriptTask.SuspendRequired Eigenschaft
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob eine Aufgabe die Ausführung angehalten werden soll, wenn der Vorgang auf einen Haltepunkt trifft. Dieser Wert wird von der Runtime-Engine für Tasks und Container festgelegt, wenn ein Breakpoint erreicht wird.
public:
property bool SuspendRequired { bool get(); void set(bool value); };public bool SuspendRequired { get; set; }member this.SuspendRequired : bool with get, setPublic Property SuspendRequired As BooleanEigenschaftswert
true, wenn die Ausführung der Aufgabe angehalten wird, wenn ein Haltepunkt auftritt; andernfalls "false".
Implementiert
Beispiele
Das folgende Codebeispiel zeigt, wie Sie die SuspendRequired Eigenschaft für eine benutzerdefinierte Aufgabe außer Kraft setzen.
public bool SuspendRequired
{
get
{
// m_suspendRequired is a Private integer declared in the custom task.
return m_suspendRequired != 0;
}
set
{
// This lock is also taken by Suspend(). Because it is possible for the package to be
// suspended and resumed in quick succession, this property "set" might happen
// before the actual Suspend() call. Without the lock, the Suspend() might reset
// the canExecute event after we set it to abort the suspension.
lock (this)
{
Interlocked.Exchange(ref m_suspendRequired, value ? 1 : 0);
if (!value)
ResumeExecution();
}
}
Public ReadOnly Property SuspendRequired() As Boolean
Get
' m_suspendRequired is a Private integer declared in the custom task.
Return m_suspendRequired <> 0
End Get
Public WriteOnly Property SuspendRequired() As Boolean
Set (ByVal Value As Boolean)
' This lock is also taken by Suspend(). Because it is possible for the package to be
' suspended and resumed in quick succession, this property "put" might happen
' before the actual Suspend() call. Without the lock, the Suspend() might reset
' the canExecute event after we set it to abort the suspension.
lock (Me)
{
Interlocked.Exchange(m_suspendRequired, value ? 1 : 0)
If Not value Then
ResumeExecution()
End If
}
End Set
End Property
Hinweise
Diese Eigenschaft ist nicht im Code festgelegt. Die Eigenschaft wird durch die Laufzeit für Vorgänge und Container festgelegt, wenn ein Haltepunkt auftritt.
Wenn Sie jedoch eine benutzerdefinierte Multithreadaufgabe schreiben, die Haltepunkte verfügbar macht, müssen Sie Code für diese Methode bereitstellen, der von der IDTSSuspend Klasse für Multithreadobjekte geerbt wird. Wenn Ihre Aufgabe single threaded ist, was bedeutet, dass die Implementierung Execute in Ihrer benutzerdefinierten Aufgabe keine neuen Threads startet, müssen Sie diese Schnittstelle nicht implementieren. Weitere Informationen zum Schreiben benutzerdefinierter Aufgaben finden Sie unter Entwickeln einer benutzerdefinierten Aufgabe.