MessageQueueTask Klasse

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.MessageQueueTask

Assembly:

Microsoft.SqlServer.MSMQTask.dll

Enthält die vom Task "Nachrichtenwarteschlange" verwendeten Methoden und Eigenschaften. Diese Klasse kann nicht vererbt werden.

public ref class MessageQueueTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::MessageQueueTask::IMessageQueueTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IMessageQueueTask
    interface IDTSBreakpointSite
    interface IDTSSuspend

Public NotInheritable Class MessageQueueTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IMessageQueueTask

Vererbung

Object

DtsObject

Task

MessageQueueTask

Attribute

DtsTaskAttribute

Implementiert

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IMessageQueueTask

Hinweise

Die Aufgabenklasse "Nachrichtenwarteschlange" ermöglicht es einem Objekt, Nachrichten an oder aus einer Warteschlange von Message Queuing (auch als MSMQ bezeichnet) zu senden und zu empfangen. Die Teilnahme an verteilten Transaktionen ist beim Ausführen des Microsoft Distributed Transaction Coordinator (MSDTC) zulässig. Eine einzelne Instanz einer Nachrichtenwarteschleife sendet entweder eine Nachricht an eine angegebene Warteschlange oder empfängt eine einzelne Nachricht aus einer angegebenen Warteschlange, und wartet ggf. auch, bis die Nachricht eingeht. Die folgenden Nachrichtentypen können gesendet werden:

• Eine Zeichenfolgennachricht, die als Wert einer Eigenschaft angegeben wird.

• Eine Datendateimeldung, die aus dem Inhalt einer angegebenen Datendatei generiert wird.

• Eine Variablenmeldung, die aus den Namen und Werten einer oder mehrerer SQL Server Integration services-Variablen generiert wird.

Die Aufzählung MQMessageType bestimmt, welches Nachrichtenformat von einer bestimmten Nachrichtenwarteschlangenaufgabe verwendet wird.

Weitere Informationen finden Sie unter "Message Queue Task".

Damit sie MessageQueueTask entweder in der API oder im SSIS-Designer arbeiten können, müssen Sie SQL Server Integrationsdienste installieren. Dieses Feature funktioniert nicht, wenn nur SQL Server Data Tools (SSDT) installiert ist.

Wichtig

Beim Konfigurieren der Aufgabe "Nachrichtenwarteschleife" zum Senden von Nachrichten können Sie eine der Verschlüsselungsalgorithmen verwenden, die derzeit vom Message Queuing, RC2 und RC4 unterstützt werden, um die Nachricht zu verschlüsseln. Diese Verschlüsselungsalgorithmen werden inzwischen im Vergleich zu neueren Algorithmen, die von Message Queuing noch nicht unterstützt werden, beide als kryptografisch schwach betrachtet. Daher sollten Sie Ihren Kryptografiebedarf sorgfältig überdenken, wenn Sie Nachrichten mithilfe des Tasks Nachrichtenwarteschlange senden.

Konstruktoren

MessageQueueTask()

Initialisiert eine neue Instanz der MessageQueueTask-Klasse.

Eigenschaften

CurrentExecutingPackageID	Ruft die ID des aktuellen, ausführenden Pakets ab oder legt sie fest.
DataFileOverWritable	Dient zum Abrufen oder Festlegen eines Booleschen Werts, der angibt, ob die Datendateinachricht eine vorhandene Datendatei überschreiben kann.
DebugMode	Ruft einen booleschen Wert ab, der angibt, ob sich das Objekt im Debugmodus befindet und ob das OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) Ereignis beim Ausführen ausgelöst werden soll, oder legt diesen fest.
DTSMessageLineageID	Ruft den Herkunftsbezeichner der Nachricht ab oder legt ihn fest.
DTSMessagePackageID	Ruft den Bezeichner des Pakets ab, das die Quelle der Nachricht darstellt, oder legt ihn fest.
DTSMessageVersionID	Ruft die Version der Nachricht ab oder legt sie fest.
EncryptionAlgo	Ruft den Namen des Verschlüsselungsalgorithmus ab, mit dem der Nachrichtentext einer privaten Nachricht verschlüsselt wird, oder legt ihn fest.
ErrorIfMessageTimeOut	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Aufgabe fehlschlägt, wenn die Nachricht ausfällt.
ExecutionValue	Gibt ein benutzerdefiniertes Objekt zurück. Dieses Feld ist schreibgeschützt. (Geerbt von Task)
MessageDataFile	Ruft den Namen der Datendatei ab, die verwendet wird, wenn MessageType auf DTSMQMessageType_DataFile festgelegt ist, oder legt ihn fest.
MessageString	Ruft die Nachricht ab, die verwendet wird, wenn MessageType auf DTSMQMessageType_String festgelegt ist, oder legt sie fest.
MessageType	Ruft einen Wert ab, der den Typ der gesendeten Nachricht angibt, wenn TaskType auf DTSMQType_Sender festgelegt ist, oder legt ihn fest.
MessageVariables	Ruft die Variablenliste ab, wenn die MQMessageType-Enumeration auf DTSMQMessageType_Variables festgelegt ist, oder legt sie fest.
MsmqConnection	Ruft den Namen der Verbindung für den MSMQ-Task ab oder legt ihn fest.
OperationDescription	Ruft die Beschreibung des Vorgangs ab oder legt sie fest.
ReceiveMessageTimeOut	Ruft einen Wert ab, mit dem die Dauer in Sekunden angegeben wird, nach der eine empfangene Nachricht ein Timeout verursacht, oder legt ihn fest.
ReceiveMessageType	Ruft einen MQMessageType-Wert ab, der den zu empfangenden Nachrichtentyp angibt, oder legt ihn fest.
ReceiveVariableMessage	Ruft den Namen der Variablen ab, in der die Nachricht gespeichert wird, oder legt ihn fest.
RemoveFromQueue	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Nachricht aus der Warteschlange entfernt werden soll.
SaveDataFileName	Ruft den Namen der Datei ab, in der eine eingehende Datendateinachricht gespeichert wird, oder legt ihn fest.
StringCompareType	Ein Wert, der die Zeichenfolgenvergleichsmethode für einen Zeichenfolgennachrichtentyp angibt, wenn dies TaskType der Wert ist DTSMQType_Receiver.
StringCompareValue	Dient zum Abrufen oder Festlegen der Zeichenfolge, auf die eine Zeichenfolgennachricht verglichen wird, wenn dies TaskType der Wert ist DTSMQType_Receiver.
StringMessageToVariableName	Ruft den Namen der Variablen ab, in der die Nachrichteninhalte gespeichert werden, oder legt ihn fest.
SuspendRequired	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Aufgabe angehalten werden soll, wenn ein Haltepunkt auftritt. Dieser Wert wird von der Runtime-Engine für Tasks und Container festgelegt, wenn ein Breakpoint erreicht wird.
TargetServerVersion	Enthält die vom Task "Nachrichtenwarteschlange" verwendeten Methoden und Eigenschaften. Diese Klasse kann nicht vererbt werden. (Geerbt von Task)
TaskType	Ruft einen Wert ab, der angibt, ob der Nachrichtentask Daten sendet oder empfängt, oder legt ihn fest.
Use2000Format	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, dass die Nachricht SQL Server 2000-Format verwendet.
UseEncryption	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Nachricht Verschlüsselung verwendet.
Version	Mitglied veraltet; siehe Hinweise. *** Gibt die Version des Tasks zurück. Diese Eigenschaft ist schreibgeschützt. (Geerbt von Task)

Methoden

AcceptBreakpointManager(BreakpointManager)	Übergibt BreakpointManager an einen Task. Diese Methode wird von der Laufzeit aufgerufen und wird nicht in Code verwendet.
CanUpdate(String)	Mitglied veraltet; siehe Hinweise. Ein boolescher Wert, der angibt, ob der neue Paket-XML-Code das alte Paket-XML aktualisieren kann. (Geerbt von Task)
Equals(Object)	Stellt fest, ob zwei Objektinstanzen gleich sind. (Geerbt von DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Führt die Aufgabe aus.
GetConnectionID(Connections, String)	Ruft eine Zeichenfolge ab, die die ID der Verbindung enthält. (Geerbt von Task)
GetConnectionName(Connections, String)	Ruft eine Zeichenfolge ab, die den Namen der Verbindung enthält. (Geerbt von Task)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Initialisiert die dem Task zugeordneten Eigenschaften. Diese Methode wird von der Laufzeit aufgerufen und wird nicht in Code verwendet.
LoadFromXML(XmlElement, IDTSInfoEvents)	Diese Methode kann durch den Anwendungscode nicht aufgerufen werden. Um ein im XML-Format (mit der Dateinamenerweiterung .xml) gespeichertes Paket zu laden, verwenden Sie die LoadPackage(String, IDTSEvents)-Methode.
ResumeExecution()	Setzt die Taskausführung nach einer Unterbrechung fort. Die Runtime-Engine setzt die Ausführung des Tasks oder Containers fort.
SaveToXML(XmlDocument, IDTSInfoEvents)	Diese Methode kann durch den Anwendungscode nicht aufgerufen werden. Um ein Paket als XML-Datei zu speichern, verwenden Sie die SaveToXml(String, Package, IDTSEvents)-Methode.
SuspendExecution()	Gibt an, dass das ausführbare Element angehalten werden muss. Diese Methode wird von der Runtime-Engine aufgerufen.
Update(String)	Mitglied veraltet; siehe Hinweise. Diese Methode aktualisiert den alten Paket-XML-Code mit dem neuen Paket-XML, wenn CanUpdate(String) er auf "true" festgelegt ist. (Geerbt von Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Überprüft, ob der Task ordnungsgemäß konfiguriert ist.