Classe MessageQueueTask

Contains the methods and properties used by the Message Queue task. This class cannot be inherited.

Gerarchia di ereditarietà

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask

Spazio dei nomi  Microsoft.SqlServer.Dts.Tasks.MessageQueueTask
Assembly:  Microsoft.SqlServer.MSMQTask (in Microsoft.SqlServer.MSMQTask.dll)

Sintassi

'Dichiarazione
Public NotInheritable Class MessageQueueTask _
    Inherits Task _
    Implements IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
'Utilizzo
Dim instance As MessageQueueTask
public sealed class MessageQueueTask : Task, 
    IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
public ref class MessageQueueTask sealed : public Task, 
    IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
[<SealedAttribute>]
type MessageQueueTask =  
    class 
        inherit Task 
        interface IDTSComponentPersist 
        interface IMessageQueueTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
    end
public final class MessageQueueTask extends Task implements IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend

Nel tipo MessageQueueTask sono esposti i membri seguenti.

Costruttori

  Nome Descrizione
Metodo pubblico MessageQueueTask Initializes a new instance of the MessageQueueTask class.

In alto

Proprietà

  Nome Descrizione
Proprietà pubblica CurrentExecutingPackageID Gets or sets the ID of the current executing package.
Proprietà pubblica DataFileOverWritable Gets or sets a Boolean that indicates whether the data file message can overwrite an existing data file.
Proprietà pubblica DebugMode Gets or sets a Boolean that indicates whether the object is in debug mode, and whether it should raise the OnBreakpointHit event while running.
Proprietà pubblica DTSMessageLineageID Gets or sets the message lineage identifier.
Proprietà pubblica DTSMessagePackageID Gets or sets the identifier of the package that is the source of the message.
Proprietà pubblica DTSMessageVersionID Gets or sets the version of the message.
Proprietà pubblica EncryptionAlgo Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.
Proprietà pubblica ErrorIfMessageTimeOut Gets or sets a Boolean specifying whether the task fails when the message times out.
Proprietà pubblica ExecutionValue Returns a user-defined object. This field is read-only. Ereditato da Task.
Proprietà pubblica MessageDataFile Gets or sets the data file name used when the MessageType is set to DTSMQMessageType_DataFile.
Proprietà pubblica MessageString Gets or sets the message to use when the MessageType is set to DTSMQMessageType_String.
Proprietà pubblica MessageType Gets or sets a value that indicates the type of message being sent when the TaskType is DTSMQType_Sender.
Proprietà pubblica MessageVariables Gets or sets the variables list when the MQMessageType enumeration is set to DTSMQMessageType_Variables.
Proprietà pubblica MsmqConnection Gets or sets the name of the connection for the MSMQ task.
Proprietà pubblica OperationDescription Gets or sets the description of the operation.
Proprietà pubblica ReceiveMessageTimeOut Gets or sets a value that specifies the number of seconds before a received message times out.
Proprietà pubblica ReceiveMessageType Gets or sets an MQMessageType value that indicates the message type to receive.
Proprietà pubblica ReceiveVariableMessage Gets or sets the name of the variable in which to store the message.
Proprietà pubblica RemoveFromQueue Gets or sets a Boolean that specifies whether the message should be removed from the queue.
Proprietà pubblica SaveDataFileName Gets or sets the name of the file to which an incoming Data File message is saved.
Proprietà pubblica StringCompareType A value that specifies the string comparison method for a String message type when the TaskType is DTSMQType_Receiver.
Proprietà pubblica StringCompareValue Gets or sets the String to which a string message is compared to when the TaskType is DTSMQType_Receiver.
Proprietà pubblica StringMessageToVariableName Gets or sets the name of the variable to which the message contents are saved.
Proprietà pubblica SuspendRequired Gets or sets a Boolean that indicates if the task should suspend when it encounters a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.
Proprietà pubblica TaskType Gets or sets a value that indicates whether the message task is sending or receiving.
Proprietà pubblica Use2000Format Gets or sets a Boolean indicating that the message uses SQL Server 2000 format.
Proprietà pubblica UseEncryption Gets or sets a Boolean indicating whether the message uses encryption.
Proprietà pubblica Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. Ereditato da Task.

In alto

Metodi

  Nome Descrizione
Metodo pubblico AcceptBreakpointManager Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.
Metodo pubblico CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. Ereditato da Task.
Metodo pubblico Equals Determines whether two object instances are equal. Ereditato da DtsObject.
Metodo pubblico Execute Runs the task. Esegue l'override di Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).
Metodo pubblico GetConnectionID Gets a String containing the ID of the connection. Ereditato da Task.
Metodo pubblico GetConnectionName Gets a String containing the name of the connection. Ereditato da Task.
Metodo pubblico GetHashCode Returns the hash code for this instance. Ereditato da DtsObject.
Metodo pubblico GetType Ereditato da Object.
Metodo pubblico InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code. Esegue l'override di Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).
Metodo pubblico LoadFromXML This method is not callable by your application code. To load a package saved in XML format (with the.xml file name extension), use the Application.LoadPackage method.
Metodo pubblico ResumeExecution Resumes execution of the task after pausing. Execution of the task or container is resumed by the runtime engine.
Metodo pubblico SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Metodo pubblico SuspendExecution Indicates that the executable needs to suspend. This method is called by the runtime engine.
Metodo pubblico ToString Ereditato da Object.
Metodo pubblico Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. Ereditato da Task.
Metodo pubblico Validate Verifies that the task is properly configured. Esegue l'override di Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).

In alto

Osservazioni

The Message Queue task class allows an object to send and receive messages to or from a queue of Message Queuing (also known as MSMQ). Participation in distributed transactions is allowed when running the Microsoft Distributed Transaction Coordinator (MSDTC). A single instance of a Message Queue task either sends one message to a specified queue or receives a single message from a specified queue, and also waits, if necessary, for the message to arrive. The following types of messages can be sent:

  • A string message, which is supplied as the value of a property.

  • A data file message, which is generated from the contents of a specified data file.

  • A variables message, which is generated from the names and values of one or more SQL Server Integration Services variables.

The enumeration MQMessageType determines which message format is used by a specific Message Queue task.

For more information, see Attività Message Queue.

For the MessageQueueTask to work in either the API or in SSIS Designer, you must install SQL Server Integration Services. This feature will not work if only SQL Server Data Tools (SSDT) is installed.

Nota importanteImportante

When configuring the Message Queue task to send messages, you can use one of the encryption algorithms that are currently supported by the Message Queuing, RC2 and RC4, to encrypt the message. Both of these encryption algorithms are now considered cryptographically weak compared to newer algorithms, which Message Queuing does not yet support. Therefore, you should consider your cryptography needs carefully when sending messages using the Message Queue task.

Protezione dei thread

I membri static (Shared in Visual Basic) pubblici di questo tipo sono affidabili. Non è invece garantita la sicurezza dei membri dell'istanza.

Vedere anche

Riferimento

Spazio dei nomi Microsoft.SqlServer.Dts.Tasks.MessageQueueTask