Contains the methods and properties used by the Message Queue task. This class cannot be inherited.
The following tables list the members exposed by the MessageQueueTask type.
Public Constructors
名称 | Description | |
---|---|---|
MessageQueueTask | Initializes a new instance of the MessageQueueTask class. |
顶部
Public Properties
名称 | Description | |
---|---|---|
![]() |
CurrentExecutingPackageID | Gets or sets the ID of the current executing package. |
![]() |
DataFileOverWritable | Gets or sets a Boolean that indicates whether the data file message can overwrite an existing data file. |
![]() |
DebugMode | Gets or sets a Boolean that indicates whether the object is in debug mode, and whether it should raise the OnBreakpointHit event while running. |
![]() |
DTSMessageLineageID | Gets or sets the message lineage identifier. |
![]() |
DTSMessagePackageID | Gets or sets the identifier of the package that is the source of the message. |
![]() |
DTSMessageVersionID | Gets or sets the version of the message. |
![]() |
EncryptionAlgo | Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message. |
![]() |
ErrorIfMessageTimeOut | Gets or sets a Boolean specifying whether the task fails when the message times out. |
![]() |
ExecutionValue | Returns a user-defined object. This field is read-only. (inherited from Task) |
![]() |
MessageDataFile | Gets or sets the data file name used when the MessageType is set to DTSMQMessageType_DataFile. |
![]() |
MessageString | Gets or sets the message to use when the MessageType is set to DTSMQMessageType_String. |
![]() |
MessageType | Gets or sets a value that indicates the type of message being sent when the TaskType is DTSMQType_Sender. |
![]() |
MessageVariables | Gets or sets the variables list when the MQMessageType enumeration is set to DTSMQMessageType_Variables. |
![]() |
MsmqConnection | Gets or sets the name of the connection for the MSMQ task. |
![]() |
OperationDescription | Gets or sets the description of the operation. |
![]() |
ReceiveMessageTimeOut | Gets or sets a value that specifies the number of seconds before a received message times out. |
![]() |
ReceiveMessageType | Gets or sets an MQMessageType value that indicates the message type to receive. |
![]() |
ReceiveVariableMessage | Gets or sets the name of the variable in which to store the message. |
![]() |
RemoveFromQueue | Gets or sets a Boolean that specifies whether the message should be removed from the queue. |
![]() |
SaveDataFileName | Gets or sets the name of the file to which an incoming Data File message is saved. |
![]() |
StringCompareType | A value that specifies the string comparison method for a String message type when the TaskType is DTSMQType_Receiver. |
![]() |
StringCompareValue | Gets or sets the String to which a string message is compared to when the TaskType is DTSMQType_Receiver. |
![]() |
StringMessageToVariableName | Gets or sets the name of the variable to which the message contents are saved. |
![]() |
SuspendRequired | Gets or sets a Boolean that indicates if the task should suspend when it encounters a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered. |
![]() |
TaskType | Gets or sets a value that indicates whether the message task is sending or receiving. |
![]() |
Use2000Format | Gets or sets a Boolean indicating that the message uses SQL Server 2000 format. |
![]() |
UseEncryption | Gets or sets a Boolean indicating whether the message uses encryption. |
![]() |
Version | Returns the version of the task. This property is read-only. (inherited from Task) |
![]() |
WaitForMe | Returns a Boolean that indicates whether the parent container should wait for completion of this task. This property is read-only. (inherited from Task) |
顶部
Public Methods
(see also Protected Methods )
名称 | Description | |
---|---|---|
![]() |
AcceptBreakpointManager | Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code. |
![]() |
CanUpdate | (inherited from Task ) |
![]() |
Equals | Overloaded. (inherited from DtsObject ) |
![]() |
Execute | Overridden. Runs the task. |
![]() |
GetConnectionID | (inherited from Task ) |
![]() |
GetConnectionName | (inherited from Task ) |
![]() |
GetHashCode | Returns the hash code for this instance. (inherited from DtsObject) |
![]() |
GetType | (inherited from Object ) |
![]() |
InitializeTask | Overridden. Initializes the properties associated with the task. This method is called by the runtime and is not used in code. |
![]() |
LoadFromXML | This method is not callable by your application code. To load a package saved in XML format (with the.xml file name extension), use the Application.LoadPackage method. |
![]() ![]() |
op_Equality | (inherited from DtsObject ) |
![]() ![]() |
op_Inequality | (inherited from DtsObject ) |
![]() ![]() |
ReferenceEquals | (inherited from Object ) |
![]() |
ResumeExecution | Resumes execution of the task after pausing. Execution of the task or container is resumed by the runtime engine. |
![]() |
SaveToXML | This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method. |
![]() |
SuspendExecution | Indicates that the executable needs to suspend. This method is called by the runtime engine. |
![]() |
ToString | (inherited from Object ) |
![]() |
Update | (inherited from Task ) |
![]() |
Validate | Overridden. Verifies that the task is properly configured. |
顶部
Protected Methods
名称 | Description | |
---|---|---|
![]() |
Finalize | (inherited from Object ) |
![]() |
MemberwiseClone | (inherited from Object ) |
顶部
请参阅
参考
MessageQueueTask Class
Microsoft.SqlServer.Dts.Tasks.MessageQueueTask Namespace