MessageQueueTask Clase

Referencia

Definición

Espacio de nombres:: Microsoft.SqlServer.Dts.Tasks.MessageQueueTask

Ensamblado:: Microsoft.SqlServer.MSMQTask.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Contiene los métodos y propiedades utilizados por la tarea Cola de mensajes. Esta clase no puede heredarse.

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

Herencia: Object

DtsObject

Task
MessageQueueTask

Atributos: DtsTaskAttribute

Implementaciones: IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IMessageQueueTask

Comentarios

La clase de tarea Cola de mensajes permite que un objeto envíe y reciba mensajes hacia o desde una cola de Message Queuing (también conocida como MSMQ). Se permite la participación en transacciones distribuidas al ejecutar el Coordinador de transacciones distribuidas de Microsoft (MSDTC). Una única instancia de una tarea Cola de mensajes envía un mensaje a una cola especificada o recibe un único mensaje de una cola especificada y también espera, si es necesario, para que llegue el mensaje. Se pueden enviar los siguientes tipos de mensajes:

Mensaje de cadena, que se proporciona como valor de una propiedad.
Mensaje de archivo de datos, que se genera a partir del contenido de un archivo de datos especificado.
Mensaje de variables, que se genera a partir de los nombres y valores de una o varias variables de Integration Services SQL Server.

La enumeración MQMessageType determina qué formato de mensaje usa una tarea de cola de mensajes específica.

Para obtener más información, vea Tarea cola de mensajes.

Para que MessageQueueTask funcione en la API o en el Diseñador de SSIS, debe instalar SQL Server Integration Services. Esta característica no funcionará si solo se instala SQL Server Data Tools (SSDT).

Importante

Al configurar la tarea Cola de mensajes para enviar mensajes, puede usar uno de los algoritmos de cifrado admitidos actualmente por Message Queuing, RC2 y RC4 para cifrar el mensaje. Ambos algoritmos de cifrado se consideran en estos momentos criptográficamente menos seguros que otros algoritmos más recientes con los que Message Queue Server aún no es compatible. Por tanto, debe considerar con detenimiento sus necesidades criptográficas a la hora de enviar mensajes con la tarea Cola de mensajes.

Constructores

MessageQueueTask()

Inicializa una nueva instancia de la clase MessageQueueTask.

Propiedades

CurrentExecutingPackageID	Obtiene o establece el identificador del paquete actualmente en ejecución.
DataFileOverWritable	Obtiene o establece un valor booleano que indica si el mensaje del archivo de datos puede sobrescribir un archivo de datos existente.
DebugMode	Obtiene o establece un valor booleano que indica si el objeto está en modo de depuración y si debe generar el OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) evento mientras se ejecuta.
DTSMessageLineageID	Obtiene o establece el identificador de linaje del mensaje.
DTSMessagePackageID	Obtiene o establece el identificador del paquete que constituye el origen del mensaje.
DTSMessageVersionID	Obtiene o establece la versión del mensaje.
EncryptionAlgo	Obtiene o establece el nombre del algoritmo de cifrado utilizado para cifrar el cuerpo del mensaje de un mensaje privado.
ErrorIfMessageTimeOut	Obtiene o establece un valor booleano que especifica si se produce un error en la tarea cuando se agota el tiempo de espera del mensaje.
ExecutionValue	Devuelve un objeto definido por el usuario. Este campo es de solo lectura. (Heredado de Task)
MessageDataFile	Obtiene o establece el nombre del archivo de datos utilizado cuando la propiedad MessageType está establecida en DTSMQMessageType_DataFile.
MessageString	Obtiene o establece el mensaje que se utilizará cuando la propiedad MessageType está establecida en DTSMQMessageType_String.
MessageType	Obtiene o establece un valor que indica el tipo de mensaje que se envía cuando TaskType es DTSMQType_Sender.
MessageVariables	Obtiene o establece la lista de variables cuando la enumeración MQMessageType está establecida en DTSMQMessageType_Variables.
MsmqConnection	Obtiene o establece el nombre de la conexión para la tarea MSMQ.
OperationDescription	Obtiene o establece la descripción de la operación.
ReceiveMessageTimeOut	Obtiene o establece un valor que especifica el número de segundos que deben transcurrir antes de que un mensaje recibido expire.
ReceiveMessageType	Obtiene o establece un valor MQMessageType que indica el tipo de mensaje que se va a recibir.
ReceiveVariableMessage	Obtiene o establece el nombre de la variable en la que se almacenará el mensaje.
RemoveFromQueue	Obtiene o establece un valor booleano que especifica si el mensaje se debe quitar de la cola.
SaveDataFileName	Obtiene o establece el nombre del archivo en el que se guarda un mensaje de archivo de datos entrante.
StringCompareType	Valor que especifica el método de comparación de cadenas para un tipo de mensaje String cuando TaskType es DTSMQType_Receiver.
StringCompareValue	Obtiene o establece la cadena a la que se compara un mensaje de cadena con cuando TaskType es DTSMQType_Receiver.
StringMessageToVariableName	Obtiene o establece el nombre de la variable en la que se guarda el contenido del mensaje.
SuspendRequired	Obtiene o establece un valor booleano que indica si la tarea debe suspenderse cuando encuentra un punto de interrupción. El motor en tiempo de ejecución establece este valor para tareas y contenedores cuando se encuentra un punto de interrupción.
TargetServerVersion	Contiene los métodos y propiedades utilizados por la tarea Cola de mensajes. Esta clase no puede heredarse. (Heredado de Task)
TaskType	Obtiene o establece un valor que indica si la tarea de mensaje está enviando o recibiendo.
Use2000Format	Obtiene o establece un valor booleano que indica que el mensaje usa SQL Server formato 2000.
UseEncryption	Obtiene o establece un valor booleano que indica si el mensaje usa cifrado.
Version	* Miembro desusado; ver Comentarios. * Devuelve la versión de la tarea. Esta propiedad es de solo lectura. (Heredado de Task)

Métodos

AcceptBreakpointManager(BreakpointManager)	Pasa una clase BreakpointManager a una tarea. El motor en tiempo de ejecución llama a este método, que no se usa en el código.
CanUpdate(String)	*** Miembro desusado; ver Comentarios. Valor booleano que indica si el nuevo xml del paquete puede actualizar el XML del paquete anterior. (Heredado de Task)
Equals(Object)	Determina si dos instancias de objeto son iguales. (Heredado de DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Ejecuta la tarea.
GetConnectionID(Connections, String)	Obtiene una cadena que contiene el identificador de la conexión. (Heredado de Task)
GetConnectionName(Connections, String)	Obtiene una cadena que contiene el nombre de la conexión. (Heredado de Task)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Inicializa las propiedades asociadas a la tarea. El motor en tiempo de ejecución llama a este método, que no se usa en el código.
LoadFromXML(XmlElement, IDTSInfoEvents)	No se pueden realizar llamadas a este método desde el código de la aplicación. Para cargar un paquete guardado en formato XML (con la extensión de nombre de archivo .xml), utilice el método LoadPackage(String, IDTSEvents).
ResumeExecution()	Reanuda la ejecución de la tarea después de una pausa. El motor de ejecución reanuda la ejecución de la tarea o el contenedor.
SaveToXML(XmlDocument, IDTSInfoEvents)	No se pueden realizar llamadas a este método desde el código de la aplicación. Para guardar un paquete como .xml, utilice el método SaveToXml(String, Package, IDTSEvents).
SuspendExecution()	Indica que el ejecutable se debe suspender. El motor de ejecución llama a este método.
Update(String)	*** Miembro desusado; ver Comentarios. Este método actualiza el XML del paquete antiguo con el nuevo XML de paquete si CanUpdate(String) se establece en true. (Heredado de Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Comprueba si la tarea está correctamente configurada.

Se aplica a