MessageQueueTask Classe

Definição

Contém os métodos e as propriedades usados pela tarefa Fila de Mensagens. Essa classe não pode ser herdada.

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
Herança
MessageQueueTask
Atributos
Implementações

Comentários

A classe de tarefa fila de mensagens permite que um objeto envie e receba mensagens de ou para uma fila de enfileiramento de mensagens (também conhecida como MSMQ). A participação em transações distribuídas é permitida ao executar o Microsoft Coordenador de Transações Distribuídas (MSDTC). Uma única instância de uma tarefa fila de mensagens envia uma mensagem para uma fila especificada ou recebe uma única mensagem de uma fila especificada e também espera, se necessário, que a mensagem chegue. Os seguintes tipos de mensagens podem ser enviados:

  • Uma mensagem de cadeia de caracteres, que é fornecida como o valor de uma propriedade.

  • Uma mensagem de arquivo de dados, que é gerada com base no conteúdo de um arquivo de dados especificado.

  • Uma mensagem de variáveis, que é gerada com base nos nomes e valores de uma ou mais SQL Server Integration Services variáveis.

A enumeração MQMessageType determina qual formato de mensagem é usado por uma tarefa específica da fila de mensagens.

Para obter mais informações, consulte tarefa fila de mensagens.

Para que o MessageQueueTask funcione na API ou no Designer SSIS, você deve instalar o SQL Server Integration Services . Esse recurso só funcionará se o SQL Server Data Tools (SSDT) for instalado.

Importante

Ao configurar a tarefa fila de mensagens para enviar mensagens, você pode usar um dos algoritmos de criptografia que atualmente têm suporte no enfileiramento de mensagens, RC2 e RC4, para criptografar a mensagem. Atualmente, ambos algoritmos de criptografia são considerados criptograficamente fracos quando comparados a algoritmos mais novos, que não têm suporte no serviço de Enfileiramento de Mensagens. Então, você deve considerar cuidadosamente suas necessidades de criptografia ao enviar mensagens que usam a tarefa Fila de Mensagens.

Construtores

MessageQueueTask()

Inicializa uma nova instância da classe MessageQueueTask.

Propriedades

CurrentExecutingPackageID

Obtém ou define a ID do pacote em execução no momento.

DataFileOverWritable

Obtém ou define um booliano que indica se a mensagem do arquivo de dados pode substituir um arquivo de dados existente.

DebugMode

Obtém ou define um booliano que indica se o objeto está no modo de depuração e se ele deve gerar o OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) evento durante a execução.

DTSMessageLineageID

Obtém ou define o identificador de linhagem da mensagem.

DTSMessagePackageID

Obtém ou define o identificador do pacote que é a origem da mensagem.

DTSMessageVersionID

Obtém ou define a versão da mensagem.

EncryptionAlgo

Obtém ou define o nome do algoritmo de criptografia usado para criptografar o corpo da mensagem de uma mensagem privada.

ErrorIfMessageTimeOut

Obtém ou define um booliano que especifica se a tarefa falha quando a mensagem atinge o tempo limite.

ExecutionValue

Retorna um objeto definido pelo usuário. Este campo é somente leitura.

(Herdado de Task)
MessageDataFile

Obtém ou define o nome de arquivo de dados usado quando o MessageType é definido como DTSMQMessageType_DataFile.

MessageString

Obtém ou define a mensagem a ser usada quando o MessageType é definido como DTSMQMessageType_String.

MessageType

Obtém ou define um valor que indica o tipo de mensagem sendo enviado quando o TaskType é DTSMQType_Sender.

MessageVariables

Obtém ou define a lista de variáveis quando a enumeração MQMessageType é definida como DTSMQMessageType_Variables.

MsmqConnection

Obtém ou define o nome da conexão com a tarefa MSMQ.

OperationDescription

Obtém ou define a descrição da operação.

ReceiveMessageTimeOut

Obtém ou define um valor que especifica o número de segundos antes de o tempo limite de uma mensagem recebida ser atingido.

ReceiveMessageType

Obtém ou define um valor MQMessageType que indica o tipo de mensagem a ser recebido.

ReceiveVariableMessage

Obtém ou define o nome da variável na qual armazenar a mensagem.

RemoveFromQueue

Obtém ou define um booliano que especifica se a mensagem deve ser removida da fila.

SaveDataFileName

Obtém ou define o nome do arquivo no qual uma mensagem de Arquivo de Dados de entrada é salva.

StringCompareType

Um valor que especifica o método de comparação de cadeia de caracteres para um tipo de mensagem de cadeia de caracteres quando o TaskType é DTSMQType_Receiver .

StringCompareValue

Obtém ou define a cadeia de caracteres à qual uma mensagem de cadeia de caracteres é comparada quando TaskType é DTSMQType_Receiver .

StringMessageToVariableName

Obtém ou define o nome da variável na qual o conteúdo da mensagem é salvo.

SuspendRequired

Obtém ou define um booliano que indica se a tarefa deve ser suspensa quando encontra um ponto de interrupção. Esse valor é definido pelo mecanismo de runtime para tarefas e contêineres quando um ponto de interrupção é encontrado.

TargetServerVersion (Herdado de Task)
TaskType

Obtém ou define um valor que indica se a tarefa de mensagem está enviando ou recebendo.

Use2000Format

Obtém ou define um valor booleano que indica que a mensagem usa SQL Server formato 2000.

UseEncryption

Obtém ou define um valor booleano que indica se a mensagem usa criptografia.

Version

***  Membro preterido; consulte comentários. ** _ Retorna a versão da tarefa. Esta propriedade é somente para leitura.

(Herdado de Task)

Métodos

AcceptBreakpointManager(BreakpointManager)

Passa um BreakpointManager para uma tarefa. Esse método é chamado pelo runtime e não é usado em código.

CanUpdate(String)

***  Membro preterido; consulte comentários. ** _ Um booliano que indica se o novo XML do pacote pode atualizar o XML do pacote antigo.

(Herdado de Task)
Equals(Object)

Determina se duas instâncias de objeto são iguais.

(Herdado de DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Executa a tarefa.

GetConnectionID(Connections, String)

Obtém uma cadeia de caracteres que contém a ID da conexão.

(Herdado de Task)
GetConnectionName(Connections, String)

Obtém uma cadeia de caracteres que contém o nome da conexão.

(Herdado de Task)
GetHashCode()

Retorna o código hash para a instância.

(Herdado de DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Inicializa as propriedades associadas à tarefa. Esse método é chamado pelo runtime e não é usado em código.

LoadFromXML(XmlElement, IDTSInfoEvents)

Esse método não pode ser chamado por seu código de aplicativo. Para carregar um pacote salvo no formato XML (com a extensão de nome de arquivo .xml), use o método LoadPackage(String, IDTSEvents).

ResumeExecution()

Retoma a execução da tarefa depois de pausar. A execução da tarefa ou contêiner é retomada pelo mecanismo de runtime.

SaveToXML(XmlDocument, IDTSInfoEvents)

Esse método não pode ser chamado por seu código de aplicativo. Para salvar um pacote como .xml, use o método SaveToXml(String, Package, IDTSEvents).

SuspendExecution()

Indica se o executável precisa ser suspenso. Esse método é chamado pelo mecanismo de runtime.

Update(String)

***  Membro preterido; consulte comentários. ** _ Esse método atualizará o XML do pacote antigo com o novo XML do pacote se CanUpdate(String) for definido como true.

(Herdado de Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifica se a tarefa está configurada corretamente.

Aplica-se a