MessageQueueTask Classe

Definizione

Spazio dei nomi:

Microsoft.SqlServer.Dts.Tasks.MessageQueueTask

Assembly:

Microsoft.SqlServer.MSMQTask.dll

Contiene i metodi e le proprietà utilizzati dall'attività 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 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

Ereditarietà

Object

DtsObject

Task

MessageQueueTask

Attributi

DtsTaskAttribute

Implementazioni

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IMessageQueueTask

Commenti

La classe di attività Message Queue consente a un oggetto di inviare e ricevere messaggi da o verso una coda di Accodamento messaggi (noto anche come MSMQ). La partecipazione alle transazioni distribuite è consentita quando si esegue Microsoft Distributed Transaction Coordinator (MSDTC). Una singola istanza di un'attività Message Queue invia un messaggio a una coda specificata o riceve un singolo messaggio da una coda specificata e attende, se necessario, per l'arrivo del messaggio. È possibile inviare i tipi di messaggi seguenti:

• Messaggio stringa, fornito come valore di una proprietà.

• Messaggio del file di dati generato dal contenuto di un file di dati specificato.

• Messaggio di variabili, generato dai nomi e dai valori di una o più variabili di Integration Services SQL Server.

L'enumerazione MQMessageType determina il formato del messaggio utilizzato da un'attività Message Queue specifica.

Per altre informazioni, vedere Attività Message Queue.

Affinché funzioni MessageQueueTask nell'API o in Designer SSIS, è necessario installare SQL Server Integration Services. Questa funzionalità non funzionerà se è installato solo SQL Server Data Tools (SSDT).

Importante

Quando si configura l'attività Message Queue per l'invio di messaggi, è possibile usare uno degli algoritmi di crittografia attualmente supportati da Accodamento messaggi, RC2 e RC4, per crittografare 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

MessageQueueTask()

Inizializza una nuova istanza della classe MessageQueueTask.

Proprietà

CurrentExecutingPackageID	Ottiene o imposta l'ID del pacchetto in esecuzione.
DataFileOverWritable	Ottiene o imposta un valore booleano che indica se il messaggio del file di dati può sovrascrivere un file di dati esistente.
DebugMode	Ottiene o imposta un valore Boolean che indica se l'oggetto è in modalità di debug e se deve generare l'evento durante l'esecuzione OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) .
DTSMessageLineageID	Ottiene o imposta l'identificatore di derivazione del messaggio.
DTSMessagePackageID	Ottiene o imposta l'identificatore del pacchetto che rappresenta l'origine del messaggio.
DTSMessageVersionID	Ottiene o imposta la versione del messaggio.
EncryptionAlgo	Ottiene o imposta il nome dell'algoritmo di crittografia utilizzato per crittografare il corpo del messaggio di un messaggio privato.
ErrorIfMessageTimeOut	Ottiene o imposta un valore Boolean che specifica se l'attività ha esito negativo quando si verifica il timeout del messaggio.
ExecutionValue	Restituisce un oggetto definito dall'utente. Questo campo è di sola lettura. (Ereditato da Task)
MessageDataFile	Ottiene o imposta il nome del file di dati utilizzato quando la proprietà MessageType è impostata su DTSMQMessageType_DataFile.
MessageString	Ottiene o imposta il messaggio da utilizzare quando la proprietà MessageType è impostata su DTSMQMessageType_String.
MessageType	Ottiene o imposta un valore che indica il tipo di messaggio inviato quando TaskType corrisponde a DTSMQType_Sender.
MessageVariables	Ottiene o imposta l'elenco di variabili da utilizzare quando l'enumerazione MQMessageType è impostata su DTSMQMessageType_Variables.
MsmqConnection	Ottiene o imposta il nome della connessione per l'attività MSMQ.
OperationDescription	Ottiene o imposta la descrizione dell'operazione.
ReceiveMessageTimeOut	Ottiene o imposta un valore che specifica il numero di secondi che devono trascorrere prima che si verifichi il timeout di un messaggio ricevuto.
ReceiveMessageType	Ottiene o imposta un valore MQMessageType che indica il tipo di messaggio da ricevere.
ReceiveVariableMessage	Ottiene o imposta il nome della variabile in cui archiviare il messaggio.
RemoveFromQueue	Ottiene o imposta un valore booleano che specifica se il messaggio deve essere rimosso dalla coda.
SaveDataFileName	Ottiene o imposta il nome del file in cui viene salvato un messaggio con file di dati in arrivo.
StringCompareType	Valore che specifica il metodo di confronto tra stringhe per un tipo di messaggio String quando è TaskTypeDTSMQType_Receiver.
StringCompareValue	Ottiene o imposta l'oggetto String a cui viene confrontato un messaggio stringa quando TaskType è DTSMQType_Receiver.
StringMessageToVariableName	Ottiene o imposta il nome della variabile in cui viene salvato il contenuto del messaggio.
SuspendRequired	Ottiene o imposta un valore booleano che indica se l'attività deve essere sospesa quando rileva un punto di interruzione. Questo valore viene impostato dal motore di runtime per le attività e i contenitori quando viene rilevato un punto di interruzione.
TargetServerVersion	Contiene i metodi e le proprietà utilizzati dall'attività Message Queue. La classe non può essere ereditata. (Ereditato da Task)
TaskType	Ottiene o imposta un valore che indica se l'attività sta inviando o ricevendo il messaggio.
Use2000Format	Ottiene o imposta un valore Boolean che indica che il messaggio utilizza SQL Server formato 2000.
UseEncryption	Ottiene o imposta un valore Boolean che indica se il messaggio utilizza la crittografia.
Version	*** Membro deprecato; vedere la sezione Osservazioni. Restituisce la versione dell'attività. Questa proprietà è di sola lettura. (Ereditato da Task)

Metodi

AcceptBreakpointManager(BreakpointManager)	Passa un oggetto BreakpointManager a un'attività. Questo metodo viene chiamato dal runtime e non è utilizzato nel codice.
CanUpdate(String)	*** Membro deprecato; vedere la sezione Osservazioni. Valore booleano che indica se il nuovo xml del pacchetto può aggiornare il codice XML del pacchetto precedente. (Ereditato da Task)
Equals(Object)	Determina se due istanze di un oggetto sono uguali. (Ereditato da DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Esegue l'attività.
GetConnectionID(Connections, String)	Ottiene una stringa contenente l'ID della connessione. (Ereditato da Task)
GetConnectionName(Connections, String)	Ottiene una stringa contenente il nome della connessione. (Ereditato da Task)
GetHashCode()	Restituisce il codice hash per l'istanza. (Ereditato da DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Inizializza le proprietà associate all'attività. Questo metodo viene chiamato dal runtime e non è utilizzato nel codice.
LoadFromXML(XmlElement, IDTSInfoEvents)	Non è possibile chiamare questo metodo dal codice dell'applicazione. Per caricare un pacchetto salvato in formato XML (con estensione di file xml), utilizzare il metodo LoadPackage(String, IDTSEvents).
ResumeExecution()	Riprende l'esecuzione dell'attività dopo la sospensione. L'esecuzione dell'attività o del contenitore viene ripresa dal motore di runtime.
SaveToXML(XmlDocument, IDTSInfoEvents)	Non è possibile chiamare questo metodo dal codice dell'applicazione. Per salvare un pacchetto come file con estensione xml, utilizzare il metodo SaveToXml(String, Package, IDTSEvents).
SuspendExecution()	Indica la necessità di sospendere l'eseguibile. Questo metodo viene chiamato dal motore di runtime.
Update(String)	*** Membro deprecato; vedere la sezione Osservazioni. Questo metodo aggiorna il codice XML del pacchetto precedente con il nuovo codice XML del pacchetto se CanUpdate(String) è impostato su true. (Ereditato da Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Verifica che l'attività sia configurata correttamente.