Microsoft.SqlServer.MSMQTask

This namespace contains the members required to create a Message Queue task.

Contains the members used to generate a message for the Message Queue Task when the is .

Initializes a new instance of the class.

A String that contains the contents of the message.

The name of the data file that contains the message.

The ID of the package.

Describes the type of encryption, if any, that the Message Queue task uses.

Initializes a new instance of the class.

Gets or sets the encryption algorithm used to encrypt the message body of a private message.

A valid value from the EncryptionAlgorithm enumeration. The EncryptionAlgorithm is an enumeration in the .NET Framework Class Library, and is in the System.Messaging namespace.

Contains the formatter used to serialize an object into or deserialize an object from the body of a message read from or written to the queue.

Initializes a new instance of the class.

Gets a value that indicates whether the message queue can be read.

true if the message object can be read. The message queue whose readability is in question.

Creates a new object that is a copy of the current instance.

A new object that is a copy of this instance.

Reads the message.

An object containing the message. The message to read.

Opens a memory stream and writes the message object. This method serializes the message object including PackageID, VersionID, name of the datafile and the file contents.

The message object to write. The variable that the message object is in.

Contains the methods and properties used by the Message Queue task. This class cannot be inherited.

Initializes a new instance of the class.

Passes a to a task. This method is called by the runtime and is not used in code.

The to use for controlling breakpoints on this task.

Runs the task.

A value from the enumeration. A collection of connections used by the task. A object for locking variables. An object implementing the interface. An object implementing the interface. The transaction object that the container is a part of. The runtime provides the transaction for the container, based on the property. This value can be null.

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.

A collection of connections used by the task. A object for locking variables. An object implementing the interface. An object implementing the interface. A collection containing events to be raised during execution of the task. A collection of log entries. An object reference tracker.

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 method.

The node containing the object to be loaded and persisted. An object that implements the interface for firing events (errors, warnings, and so on) during persistence.

Resumes execution of the task after pausing. Execution of the task or container is resumed by the runtime engine.

This method is not callable by your application code. To save a package as .xml, use the method.

The XML document to save the information to. An object that implements the interface for firing events (errors, warnings, and so on) during persistence.

Indicates that the executable needs to suspend. This method is called by the runtime engine.

Verifies that the task is properly configured.

A value from the enumeration. A collection of connections used by the task. A object for locking variables. An object implementing the interface. An object implementing the interface.

Gets or sets the ID of the current executing package.

A String that contains the ID, represented as a GUID, of the current executing package.

Gets or sets a Boolean that indicates whether the data file message can overwrite an existing data file.

true if the message can overwrite an existing file; false if it does not overwrite.

Gets or sets a Boolean that indicates whether the object is in debug mode, and whether it should raise the event while running.

true indicates that the object is in debug mode, and raises the event. false indicates that the object is not in debug mode.

Gets or sets the message lineage identifier.

A String that contains the message lineage identifier.

Gets or sets the identifier of the package that is the source of the message.

A String that contains the identifier of the package that is the source of the message.

Gets or sets the version of the message.

A String that contains the version of the message.

Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.

The name of the encryption algorithm.

Gets or sets a Boolean specifying whether the task fails when the message times out.

true if the task fails when the message times out; false if the task does not.

Gets or sets the data file name used when the is set to .

A String that contains the name of the data file used.

Gets or sets the message to use when the is set to .

A String that contains the message.

Gets or sets a value that indicates the type of message being sent when the is .

A value from the enumeration that indicates the type of message to send.

Gets or sets the variables list when the enumeration is set to .

A String that contains the list of variables used in the message.

Gets or sets the name of the connection for the MSMQ task.

A String that contains the MSMQ connection name.

Gets or sets the description of the operation.

A String that contains a description of the operation.

Gets or sets a value that specifies the number of seconds before a received message times out.

A Long that indicates the number of seconds before a message times out.

Gets or sets an value that indicates the message type to receive.

An value that indicates the type of the incoming message.

Gets or sets the name of the variable in which to store the message.

A String that contains the name of the variable to store the message in.

Gets or sets a Boolean that specifies whether the message should be removed from the queue.

true if the message should be removed from the queue; false if it should be left in the queue.

Gets or sets the name of the file to which an incoming Data File message is saved.

A String that indicates the name of the file to which an incoming Data File message is saved.

A value that specifies the string comparison method for a String message type when the is .

One of the valid values in , indicating the string comparison method.

Gets or sets the String to which a string message is compared to when the is .

A String used for comparison when the is .

Gets or sets the name of the variable to which the message contents are saved.

A String that contains the variable to store the message in.

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.

true if the task suspends when it encounters a breakpoint.

Gets or sets a value that indicates whether the message task is sending or receiving.

A valid value from the enumeration.

Gets or sets a Boolean indicating that the message uses SQL Server 2000 format.

false indicates that the SQL Server 2000 format is not used; true indicates that the SQL Server 2000 format is used.

Gets or sets a Boolean indicating whether the message uses encryption.

true indicates that encryption is used; false indicates that encryption is not used.

Describes the message type when the is set to a value of .

Message source is a data file.

Message source is a string.

Message source is in a variable, and the destination is also a variable.

Message source is text, and the destination is a variable. This enumeration is only valid when the Message Queue task is receiving a message.

Contains values that control the method of comparison that is used by the Message Queue task when the Message Queue task is receiving a message. To receive a message, the must be set to , and the message type must be set to .

Specifies that the message content must contain the string in the .

Specifies that the message content must exactly match the string in the .

Specifies whether the comparison distinguishes between uppercase and lowercase letters. When this enumeration value is used, the string comparison ignores case. For example, "ABC" is identical to "abc".

Specifies that no comparison is done.

Indicates if the Message Queue task is sending or receiving a message.

The task is receiving a message.

The task is sending a message.

Specifies the events that are used for logging with the Message Queue task.

Log after opening the queue.

Log before opening the queue.

Log the timestamp before receiving the message.

Log the timestamp before sending the message.

Log the timestamp after the message is received.

Log the timestamp after sending the message.

Log that the task has timed out.

Log the task info only if logging is enabled and the event filter status is set to true.