Share via

  • Article

MessageQueueTask Members

Include Protected Members
Include Inherited Members

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

The MessageQueueTask type exposes the following members.

Constructors

  Name Description
Public method MessageQueueTask() Initializes a new instance of the MessageQueueTask class.

Top

Methods

  Name Description
Public method AcceptBreakpointManager(BreakpointManager) Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.
Public method CanUpdate(String) *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public method Equals(Object) Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected method Finalize() (Inherited from Object.)
Public method GetConnectionID(Connections, String) Gets a String containing the ID of the connection. (Inherited from Task.)
Public method GetConnectionName(Connections, String) Gets a String containing the name of the connection. (Inherited from Task.)
Public method GetHashCode() Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType() (Inherited from Object.)
Public method InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Public method LoadFromXML(XmlElement, IDTSInfoEvents) 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.
Protected method MemberwiseClone() (Inherited from Object.)
Public method ResumeExecution() Resumes execution of the task after pausing. Execution of the task or container is resumed by the runtime engine.
Public method SaveToXML(XmlDocument, IDTSInfoEvents) This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method SuspendExecution() Indicates that the executable needs to suspend. This method is called by the runtime engine.
Public method ToString() (Inherited from Object.)
Public method Update(String%) *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
Public method Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Verifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Properties

  Name Description
Public property CurrentExecutingPackageID Gets or sets the ID of the current executing package.
Public property DataFileOverWritable Gets or sets a Boolean that indicates whether the data file message can overwrite an existing data file.
Public property 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.
Public property DTSMessageLineageID Gets or sets the message lineage identifier.
Public property DTSMessagePackageID Gets or sets the identifier of the package that is the source of the message.
Public property DTSMessageVersionID Gets or sets the version of the message.
Public property EncryptionAlgo Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.
Public property ErrorIfMessageTimeOut Gets or sets a Boolean specifying whether the task fails when the message times out.
Public property ExecutionValue Returns a user-defined object. This field is read-only. (Inherited from Task.)
Public property MessageDataFile Gets or sets the data file name used when the MessageType is set to DTSMQMessageType_DataFile.
Public property MessageString Gets or sets the message to use when the MessageType is set to DTSMQMessageType_String.
Public property MessageType Gets or sets a value that indicates the type of message being sent when the TaskType is DTSMQType_Sender.
Public property MessageVariables Gets or sets the variables list when the MQMessageType enumeration is set to DTSMQMessageType_Variables.
Public property MsmqConnection Gets or sets the name of the connection for the MSMQ task.
Public property OperationDescription Gets or sets the description of the operation.
Public property ReceiveMessageTimeOut Gets or sets a value that specifies the number of seconds before a received message times out.
Public property ReceiveMessageType Gets or sets an MQMessageType value that indicates the message type to receive.
Public property ReceiveVariableMessage Gets or sets the name of the variable in which to store the message.
Public property RemoveFromQueue Gets or sets a Boolean that specifies whether the message should be removed from the queue.
Public property SaveDataFileName Gets or sets the name of the file to which an incoming Data File message is saved.
Public property StringCompareType A value that specifies the string comparison method for a String message type when the TaskType is DTSMQType_Receiver.
Public property StringCompareValue Gets or sets the String to which a string message is compared to when the TaskType is DTSMQType_Receiver.
Public property StringMessageToVariableName Gets or sets the name of the variable to which the message contents are saved.
Public property 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.
Public property TaskType Gets or sets a value that indicates whether the message task is sending or receiving.
Public property Use2000Format Gets or sets a Boolean indicating that the message uses SQL Server 2000 format.
Public property UseEncryption Gets or sets a Boolean indicating whether the message uses encryption.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)

Top