Share via


IMessageQueueTask Interface

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Represents an interface for the MessageQueueTask.

Namespace:  Microsoft.SqlServer.Dts.Tasks.MessageQueueTask
Assembly:  Microsoft.SqlServer.MSMQTask (in Microsoft.SqlServer.MSMQTask.dll)

Syntax

'Declaration
Public Interface IMessageQueueTask
'Usage
Dim instance As IMessageQueueTask
public interface IMessageQueueTask
public interface class IMessageQueueTask
type IMessageQueueTask =  interface end
public interface IMessageQueueTask

The IMessageQueueTask type exposes the following members.

Properties

  Name Description
Public property DataFileOverWritable Infrastructure. Gets or sets a value that indicates whether the data file message can overwrite an existing data file.
Public property DTSMessageLineageID Infrastructure. Gets or sets the message lineage identifier.
Public property DTSMessagePackageID Infrastructure. Gets or sets the identifier of the package that is the source of the message.
Public property DTSMessageVersionID Infrastructure. Gets or sets the version identifier of the message.
Public property EncryptionAlgo Infrastructure. Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.
Public property ErrorIfMessageTimeOut Infrastructure. Gets or sets a value that indicates whether the task fails when the message times out.
Public property MsmqConnection Infrastructure. Gets or sets the name of the connection for the MSMQ task.
Public property OperationDescription Infrastructure. Gets or sets the description of the operation.
Public property ReceiveMessageTimeOut Infrastructure. Gets or sets the number of seconds before a received message times out.
Public property ReceiveMessageType Infrastructure. Gets or sets an MQMessageType value that indicates the message type to receive.
Public property ReceiveVariableMessage Infrastructure. Gets or sets the name of the variable in which to store the message.
Public property RemoveFromQueue Infrastructure. Gets or sets a value that indicates whether the message should be removed from the queue.
Public property SaveDataFileName Infrastructure. Gets or sets the name of the file to which an incoming Data File message is saved.
Public property StringCompareType Infrastructure. Gets or sets the string comparison method for a String message type when the TaskType is DTSMQType_Receiver.
Public property StringCompareValue Infrastructure. Gets or sets the String to which a string message is compared to when the TaskType is DTSMQType_Receiver.
Public property StringMessageToVariableName Infrastructure. Gets or sets the name of the variable to which the message contents are saved.
Public property TaskType Infrastructure. Gets or sets the type of the message task.
Public property Use2000Format Infrastructure. Gets or sets a value that indicates whether the message uses SQL Server 2000 format.
Public property UseEncryption Infrastructure. Gets or sets a value that indicates whether the message uses encryption.

Top

See Also

Reference

Microsoft.SqlServer.Dts.Tasks.MessageQueueTask Namespace