Linguaggio

MessageQueueTask Classe

Definizione

Contiene i metodi e le proprietà utilizzati dal compito Message Queue. La classe non può essere ereditata.

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 2016; © 2015 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=13.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 2017; © 2017 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=14.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")]
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 2016; © 2015 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=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IMessageQueueTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
[<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 2017; © 2017 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=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IMessageQueueTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
[<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
Ereditarietà
MessageQueueTask
Attributi
Implementazioni

Commenti

La classe di compito Message Queue permette a un oggetto di inviare e ricevere messaggi da o da una coda di Message Queuing (nota anche come MSMQ). La partecipazione alle transazioni distribuite è consentita quando si esegue il Microsoft Distributed Transaction Coordinator (MSDTC). Un'unica istanza di un compito di Message Queue invia un messaggio a una coda specificata o ne riceve un singolo da una coda specifica, e attende, se necessario, che il messaggio arrivi. I seguenti tipi di messaggi possono essere inviati:

  • Un messaggio stringa, che viene fornito come valore di una proprietà.

  • Un messaggio file dati, generato dal contenuto di un file dati specificato.

  • Un messaggio variabile, generato dai nomi e i valori di una o più variabili di SQL Server Integration Services.

L'enumerazione MQMessageType determina quale formato di messaggio viene utilizzato da un specifico compito di Coda Messaggi.

Per ulteriori informazioni, consulta Task Message Queue.

Perché MessageQueueTask funzioni sia nell'API che in SSIS Designer, devi installare SQL Server Integration Services. Questa funzione non funzionerà se viene installato solo SQL Server Data Tools (SSDT).

Importante

Quando configuri il compito della Coda Messaggi per inviare messaggi, puoi utilizzare uno degli algoritmi di crittografia attualmente supportati dalla Coda Messaggi, RC2 e RC4, per criptare il messaggio. Entrambi gli algoritmi di crittografia sono ormai considerati vulnerabili rispetto ad altri più recenti che tuttavia non sono ancora supportati da MSMQ. È pertanto consigliabile valutare con attenzione le esigenze di crittografia ai fini dell'invio di messaggi tramite l'attività Message Queue.

Costruttori

Nome Descrizione
MessageQueueTask()

Inizializza una nuova istanza della classe MessageQueueTask.

Proprietà

Nome Descrizione
CurrentExecutingPackageID

Ottiene o imposta l'ID del pacchetto in esecuzione corrente.

DataFileOverWritable

Ottiene o imposta un Booleano che indica se il messaggio del file dati può sovrascrivere un file di dati esistente.

DebugMode

Ottiene o imposta un Boolean che indica se l'oggetto è in modalità debug e se deve generare l'evento OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) durante l'esecuzione.

DTSMessageLineageID

Ottiene o imposta l'identificatore di linea del messaggio.

DTSMessagePackageID

Ottiene o imposta l'identificativo del pacchetto che è la fonte del messaggio.

DTSMessageVersionID

Riceve o imposta la versione del messaggio.

EncryptionAlgo

Ottiene o imposta il nome dell'algoritmo di crittografia utilizzato per cifrare il corpo del messaggio di un messaggio privato.

ErrorIfMessageTimeOut

Ottiene o imposta un Boolean che specifica se il compito fallisce quando il messaggio scade il tempo.

ExecutionValue

Restituisce un oggetto definito dall'utente. Il campo è di sola lettura.

(Ereditato da Task)
MessageDataFile

Ottiene o imposta il nome del file dati usato quando è MessageType impostato a DTSMQMessageType_DataFile.

MessageString

Ottiene o imposta il messaggio da usare quando il MessageType è impostato su DTSMQMessageType_String.

MessageType

Ottiene o imposta un valore che indica il tipo di messaggio inviato quando è TaskTypeDTSMQType_Sender.

MessageVariables

Ottiene o imposta la lista delle variabili quando l'enumerazione MQMessageType è impostata a DTSMQMessageType_Variables.

MsmqConnection

Ottiene o imposta il nome della connessione per il compito MSMQ.

OperationDescription

Ottiene o imposta la descrizione dell'operazione.

ReceiveMessageTimeOut

Ottiene o imposta un valore che specifica il numero di secondi prima che un messaggio ricevuto scada il timeout.

ReceiveMessageType

Riceve o imposta un MQMessageType valore che indica il tipo di messaggio da ricevere.

ReceiveVariableMessage

Ottiene o imposta il nome della variabile in cui memorizzare il messaggio.

RemoveFromQueue

Ottiene o imposta un Booleano che specifica se il messaggio debba essere rimosso dalla coda.

SaveDataFileName

Ottiene o imposta il nome del file a cui viene salvato un messaggio Data File in arrivo.

StringCompareType

Un valore che specifica il metodo di confronto stringhe per un tipo di messaggio Stringa quando è TaskTypeDTSMQType_Receiver.

StringCompareValue

Ottiene o stabilisce la stringa a cui un messaggio di stringa è confrontato con quando è TaskTypeDTSMQType_Receiver.

StringMessageToVariableName

Ottiene o imposta il nome della variabile a cui viene salvato il contenuto del messaggio.

SuspendRequired

Ottiene o imposta un Booleano che indica se il compito deve sospendere quando incontra un punto di interruzione. Questo valore viene impostato dal motore di esecuzione per compiti e container quando si incontra un punto di interruzione.

TargetServerVersion

Contiene i metodi e le proprietà utilizzati dal compito Message Queue. La classe non può essere ereditata.

(Ereditato da Task)
TaskType

Riceve o imposta un valore che indica se il compito del messaggio è inviato o riceve.

Use2000Format

Ottiene o imposta un Booleano che indica che il messaggio utilizza il formato SQL Server 2000.

UseEncryption

Ottiene o imposta un Booleano che indica se il messaggio utilizza la crittografia.

Version

Membro deprecato; vedi Osservazioni. Restituisce la versione del compito. Questa proprietà è di sola lettura.

(Ereditato da Task)

Metodi

Nome Descrizione
AcceptBreakpointManager(BreakpointManager)

Passa a BreakpointManager un compito. Questo metodo è chiamato dal runtime e non viene utilizzato nel codice.

CanUpdate(String)

Membro deprecato; vedi Osservazioni. Un Booleano che indica se il nuovo XML del pacchetto può aggiornare il vecchio XML del pacchetto.

(Ereditato da Task)
Equals(Object)

Determina se due istanze dell'oggetto sono uguali.

(Ereditato da DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Gestisce il compito.

GetConnectionID(Connections, String)

Ottiene una stringa contenente l'ID della connessione.

(Ereditato da Task)
GetConnectionName(Connections, String)

Ottiene una stringa che contiene il nome della connessione.

(Ereditato da Task)
GetHashCode()

Restituisce il codice hash per questa istanza.

(Ereditato da DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Inizializza le proprietà associate al compito. Questo metodo è chiamato dal runtime e non viene utilizzato nel codice.

LoadFromXML(XmlElement, IDTSInfoEvents)

Questo metodo non è richiamabile dal codice applicativo. Per caricare un pacchetto salvato in formato XML (con the.xml estensione di nome file), si utilizza il LoadPackage(String, IDTSEvents) metodo.

ResumeExecution()

Riprende l'esecuzione del compito dopo la pausa. L'esecuzione del compito o del contenitore viene ripresa dal motore di runtime.

SaveToXML(XmlDocument, IDTSInfoEvents)

Questo metodo non è richiamabile dal codice applicativo. Per salvare un pacchetto come .xml, usa il SaveToXml(String, Package, IDTSEvents) metodo.

SuspendExecution()

Indica che l'eseguibile deve essere sospeso. Questo metodo è chiamato dal motore di runtime.

Update(String)

Membro deprecato; vedi Osservazioni. Questo metodo aggiorna il vecchio pacchetto XML con il nuovo pacchetto XML se CanUpdate(String) è impostato su true.

(Ereditato da Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifica che il compito sia configurato correttamente.

Si applica a