Server IP : 180.180.241.3 / Your IP : 216.73.216.252 Web Server : Microsoft-IIS/7.5 System : Windows NT NETWORK-NHRC 6.1 build 7601 (Windows Server 2008 R2 Standard Edition Service Pack 1) i586 User : IUSR ( 0) PHP Version : 5.3.28 Disable Function : NONE MySQL : ON | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/Program Files (x86)/Microsoft SQL Server/110/DTS/Tasks/en/ |
Upload File : |
<?xml version="1.0" encoding="utf-8"?> <doc> <assembly> <name>Microsoft.SqlServer.MSMQTask</name> </assembly> <members> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.DataFileMessage"> <summary>Contains the members used to generate a message for the Message Queue Task when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessageType_DataFile" />.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.DataFileMessage.#ctor"> <summary>Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.DataFileMessage" /> class. </summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.DataFileMessage.fileContents"> <summary>A String that contains the contents of the message.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.DataFileMessage.fileName"> <summary>The name of the data file that contains the message.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.DataFileMessage.strPkgId"> <summary>The ID of the package.</summary> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.EncryptionAlgorithmWrapper"> <summary>Describes the type of encryption, if any, that the Message Queue task uses.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.EncryptionAlgorithmWrapper.#ctor"> <summary>Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.EncryptionAlgorithmWrapper" /> class. </summary> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.EncryptionAlgorithmWrapper.EncryptionAlgo"> <summary>Gets or sets the encryption algorithm used to encrypt the message body of a private message.</summary> <returns>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.</returns> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Formatter"> <summary>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.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Formatter.#ctor"> <summary>Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Formatter" /> class. </summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Formatter.CanRead(System.Messaging.Message)"> <summary>Gets a value that indicates whether the message queue can be read.</summary> <returns>true if the message object can be read.</returns> <param name="msg">The message queue whose readability is in question.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Formatter.Clone"> <summary>Creates a new object that is a copy of the current instance.</summary> <returns>A new object that is a copy of this instance.</returns> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Formatter.Read(System.Messaging.Message)"> <summary>Reads the message.</summary> <returns>An object containing the message.</returns> <param name="msg">The message to read.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Formatter.Write(System.Messaging.Message,System.Object)"> <summary>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.</summary> <param name="msg">The message object to write.</param> <param name="obj">The variable that the message object is in.</param> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask"> <summary>Represents an interface for the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask" />.</summary> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.DataFileOverWritable"> <summary>Gets or sets a value that indicates whether the data file message can overwrite an existing data file.</summary> <returns>true if the message can overwrite an existing file; false if it does not overwrite.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.DTSMessageLineageID"> <summary>Gets or sets the message lineage identifier.</summary> <returns>The message lineage identifier.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.DTSMessagePackageID"> <summary>Gets or sets the identifier of the package that is the source of the message.</summary> <returns>The identifier of the package that is the source of the message.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.DTSMessageVersionID"> <summary>Gets or sets the version identifier of the message.</summary> <returns>The version identifier of the message.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.EncryptionAlgo"> <summary>Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.</summary> <returns>The name of the encryption algorithm.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.ErrorIfMessageTimeOut"> <summary>Gets or sets a value that indicates whether the task fails when the message times out.</summary> <returns>true if the task fails when the message times out; false if the task does not.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.MsmqConnection"> <summary>Gets or sets the name of the connection for the MSMQ task.</summary> <returns>The MSMQ connection name.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.OperationDescription"> <summary>Gets or sets the description of the operation.</summary> <returns>The description of the operation.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.ReceiveMessageTimeOut"> <summary>Gets or sets the number of seconds before a received message times out.</summary> <returns>The number of seconds before a message times out.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.ReceiveMessageType"> <summary>Gets or sets an <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType" /> value that indicates the message type to receive.</summary> <returns>An <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType" /> value that indicates the type of the incoming message.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.ReceiveVariableMessage"> <summary>Gets or sets the name of the variable in which to store the message.</summary> <returns>The name of the variable to store the message in.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.RemoveFromQueue"> <summary>Gets or sets a value that indicates whether the message should be removed from the queue.</summary> <returns>true if the message should be removed from the queue; false if it should be left in the queue.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.SaveDataFileName"> <summary>Gets or sets the name of the file to which an incoming Data File message is saved.</summary> <returns>The name of the file to which an incoming Data File message is saved.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.StringCompareType"> <summary>Gets or sets the string comparison method for a String message type when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver" />.</summary> <returns>One of the valid values in <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare" />, indicating the string comparison method.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.StringCompareValue"> <summary>Gets or sets the String to which a string message is compared to when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver" />.</summary> <returns>A String used for comparison when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver" />.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.StringMessageToVariableName"> <summary>Gets or sets the name of the variable to which the message contents are saved.</summary> <returns>A String that contains the variable to store the message in.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.TaskType"> <summary>Gets or sets the type of the message task.</summary> <returns>A valid value from the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType" /> enumeration that indicates the type of the message task.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.Use2000Format"> <summary>Gets or sets a value that indicates whether the message uses SQL Server 2000 format.</summary> <returns>true if the SQL Server 2000 is used; false if the SQL Server 2000 format is not used.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask.UseEncryption"> <summary>Gets or sets a value that indicates whether the message uses encryption.</summary> <returns>true if the encryption is used; false if the encryption is not used.</returns> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask"> <summary>Contains the methods and properties used by the Message Queue task. This class cannot be inherited. </summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.#ctor"> <summary>Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask" /> class. </summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.AcceptBreakpointManager(Microsoft.SqlServer.Dts.Runtime.BreakpointManager)"> <summary>Passes a <see cref="T:Microsoft.SqlServer.Dts.Runtime.BreakpointManager" /> to a task. This method is called by the runtime and is not used in code.</summary> <param name="breakPointMgr">The <see cref="T:Microsoft.SqlServer.Dts.Runtime.BreakpointManager" /> to use for controlling breakpoints on this task.</param> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.CurrentExecutingPackageID"> <summary>Gets or sets the ID of the current executing package.</summary> <returns>A String that contains the ID, represented as a GUID, of the current executing package.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.DataFileOverWritable"> <summary>Gets or sets a Boolean that indicates whether the data file message can overwrite an existing data file.</summary> <returns>true if the message can overwrite an existing file; false if it does not overwrite.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.DebugMode"> <summary>Gets or sets a Boolean that indicates whether the object is in debug mode, and whether it should raise the <see cref="M:Microsoft.SqlServer.Dts.Runtime.IDTSEvents.OnBreakpointHit(Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite,Microsoft.SqlServer.Dts.Runtime.BreakpointTarget)" /> event while running.</summary> <returns>true indicates that the object is in debug mode, and raises the <see cref="M:Microsoft.SqlServer.Dts.Runtime.IDTSEvents.OnBreakpointHit(Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite,Microsoft.SqlServer.Dts.Runtime.BreakpointTarget)" /> event. false indicates that the object is not in debug mode.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.DTSMessageLineageID"> <summary>Gets or sets the message lineage identifier.</summary> <returns>A String that contains the message lineage identifier.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.DTSMessagePackageID"> <summary>Gets or sets the identifier of the package that is the source of the message.</summary> <returns>A String that contains the identifier of the package that is the source of the message.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.DTSMessageVersionID"> <summary>Gets or sets the version of the message.</summary> <returns>A String that contains the version of the message.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.EncryptionAlgo"> <summary>Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.</summary> <returns>The name of the encryption algorithm.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.ErrorIfMessageTimeOut"> <summary>Gets or sets a Boolean specifying whether the task fails when the message times out.</summary> <returns>true if the task fails when the message times out; false if the task does not.</returns> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.Execute(Microsoft.SqlServer.Dts.Runtime.Connections,Microsoft.SqlServer.Dts.Runtime.VariableDispenser,Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents,Microsoft.SqlServer.Dts.Runtime.IDTSLogging,System.Object)"> <summary>Runs the task. </summary> <returns>A value from the <see cref="T:Microsoft.SqlServer.Dts.Runtime.DTSExecResult" /> enumeration.</returns> <param name="connections">A collection of connections used by the task.</param> <param name="variableDispenser">A <see cref="T:Microsoft.SqlServer.Dts.Runtime.VariableDispenser" /> object for locking variables.</param> <param name="events">An object implementing the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents" /> interface.</param> <param name="log">An object implementing the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSLogging" /> interface.</param> <param name="transaction">The transaction object that the container is a part of. The runtime provides the transaction for the container, based on the <see cref="P:Microsoft.SqlServer.Dts.Runtime.DtsContainer.TransactionOption" /> property. This value can be null.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.InitializeTask(Microsoft.SqlServer.Dts.Runtime.Connections,Microsoft.SqlServer.Dts.Runtime.VariableDispenser,Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents,Microsoft.SqlServer.Dts.Runtime.IDTSLogging,Microsoft.SqlServer.Dts.Runtime.EventInfos,Microsoft.SqlServer.Dts.Runtime.LogEntryInfos,Microsoft.SqlServer.Dts.Runtime.ObjectReferenceTracker)"> <summary>Initializes the properties associated with the task. This method is called by the runtime and is not used in code.</summary> <param name="connections">A collection of connections used by the task.</param> <param name="variableDispenser">A <see cref="T:Microsoft.SqlServer.Dts.Runtime.VariableDispenser" /> object for locking variables. </param> <param name="events">An object implementing the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents" /> interface.</param> <param name="log">An object implementing the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSLogging" /> interface.</param> <param name="eventInfos">A collection containing events to be raised during execution of the task.</param> <param name="logEntryInfos">A collection of log entries.</param> <param name="refTracker">An object reference tracker.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.LoadFromXML(System.Xml.XmlElement,Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents)"> <summary>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 <see cref="M:Microsoft.SqlServer.Dts.Runtime.Application.LoadPackage(System.String,Microsoft.SqlServer.Dts.Runtime.IDTSEvents)" /> method. </summary> <param name="element">The node containing the object to be loaded and persisted.</param> <param name="events">An object that implements the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents" /> interface for firing events (errors, warnings, and so on) during persistence.</param> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.MessageDataFile"> <summary>Gets or sets the data file name used when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.MessageType" /> is set to <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessageType_DataFile" />.</summary> <returns>A String that contains the name of the data file used.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.MessageString"> <summary>Gets or sets the message to use when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.MessageType" /> is set to <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessageType_String" />.</summary> <returns>A String that contains the message.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.MessageType"> <summary>Gets or sets a value that indicates the type of message being sent when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Sender" />.</summary> <returns>A value from the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType" /> enumeration that indicates the type of message to send.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.MessageVariables"> <summary>Gets or sets the variables list when the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType" /> enumeration is set to <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessageType_Variables" />.</summary> <returns>A String that contains the list of variables used in the message.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.MsmqConnection"> <summary>Gets or sets the name of the connection for the MSMQ task.</summary> <returns>A String that contains the MSMQ connection name.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.OperationDescription"> <summary>Gets or sets the description of the operation.</summary> <returns>A String that contains a description of the operation.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.ReceiveMessageTimeOut"> <summary>Gets or sets a value that specifies the number of seconds before a received message times out.</summary> <returns>A Long that indicates the number of seconds before a message times out.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.ReceiveMessageType"> <summary>Gets or sets an <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType" /> value that indicates the message type to receive.</summary> <returns>An <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType" /> value that indicates the type of the incoming message.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.ReceiveVariableMessage"> <summary>Gets or sets the name of the variable in which to store the message.</summary> <returns>A String that contains the name of the variable to store the message in.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.RemoveFromQueue"> <summary>Gets or sets a Boolean that specifies whether the message should be removed from the queue.</summary> <returns>true if the message should be removed from the queue; false if it should be left in the queue.</returns> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.ResumeExecution"> <summary>Resumes execution of the task after pausing. Execution of the task or container is resumed by the runtime engine. </summary> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.SaveDataFileName"> <summary>Gets or sets the name of the file to which an incoming Data File message is saved.</summary> <returns>A String that indicates the name of the file to which an incoming Data File message is saved.</returns> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.SaveToXML(System.Xml.XmlDocument,Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents)"> <summary>This method is not callable by your application code. To save a package as .xml, use the <see cref="M:Microsoft.SqlServer.Dts.Runtime.Application.SaveToXml(System.String,Microsoft.SqlServer.Dts.Runtime.Package,Microsoft.SqlServer.Dts.Runtime.IDTSEvents)" /> method.</summary> <param name="doc">The XML document to save the information to.</param> <param name="events">An object that implements the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents" /> interface for firing events (errors, warnings, and so on) during persistence.</param> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.StringCompareType"> <summary>A value that specifies the string comparison method for a String message type when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver" />.</summary> <returns>One of the valid values in <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare" />, indicating the string comparison method.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.StringCompareValue"> <summary>Gets or sets the String to which a string message is compared to when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver" />.</summary> <returns>A String used for comparison when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver" />.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.StringMessageToVariableName"> <summary>Gets or sets the name of the variable to which the message contents are saved.</summary> <returns>A String that contains the variable to store the message in.</returns> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.SuspendExecution"> <summary>Indicates that the executable needs to suspend. This method is called by the runtime engine. </summary> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.SuspendRequired"> <summary>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.</summary> <returns>true if the task suspends when it encounters a breakpoint.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType"> <summary>Gets or sets a value that indicates whether the message task is sending or receiving.</summary> <returns>A valid value from the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType" /> enumeration.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.Use2000Format"> <summary>Gets or sets a Boolean indicating that the message uses SQL Server 2000 format.</summary> <returns>false indicates that the SQL Server 2000 format is not used; true indicates that the SQL Server 2000 format is used.</returns> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.UseEncryption"> <summary>Gets or sets a Boolean indicating whether the message uses encryption.</summary> <returns>true indicates that encryption is used; false indicates that encryption is not used.</returns> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.Validate(Microsoft.SqlServer.Dts.Runtime.Connections,Microsoft.SqlServer.Dts.Runtime.VariableDispenser,Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents,Microsoft.SqlServer.Dts.Runtime.IDTSLogging)"> <summary>Verifies that the task is properly configured.</summary> <returns>A value from the <see cref="T:Microsoft.SqlServer.Dts.Runtime.DTSExecResult" /> enumeration.</returns> <param name="connections">A collection of connections used by the task.</param> <param name="variableDispenser">A <see cref="T:Microsoft.SqlServer.Dts.Runtime.VariableDispenser" /> object for locking variables.</param> <param name="events">An object implementing the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents" /> interface.</param> <param name="log">An object implementing the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSLogging" /> interface.</param> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType"> <summary>Describes the message type when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType" /> is set to a value of <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Sender" />.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessageType_String"> <summary>Message source is a string.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessageType_DataFile"> <summary>Message source is a data file.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessageType_Variables"> <summary>Message source is in a variable, and the destination is also a variable.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessagType_StringMessageToVariable"> <summary>Message source is text, and the destination is a variable. This enumeration is only valid when the Message Queue task is receiving a message.</summary> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare"> <summary>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 <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType" /> must be set to <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver" />, and the message type must be set to <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType.DTSMQMessageType_String" />.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare.DTSMQStringMessageCompare_None"> <summary>Specifies that no comparison is done.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare.DTSMQStringMessageCompare_Exact"> <summary>Specifies that the message content must exactly match the string in the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.StringCompareValue" />.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare.DTSMQStringMessageCompare_IgnoreCase"> <summary>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".</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare.DTSMQStringMessageCompare_Contains"> <summary>Specifies that the message content must contain the string in the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.StringCompareValue" />.</summary> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType"> <summary>Indicates if the Message Queue task is sending or receiving a message.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Sender"> <summary>The task is sending a message.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver"> <summary>The task is receiving a message.</summary> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog"> <summary>Specifies the events that are used for logging with the Message Queue task.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog.TASKINFO"> <summary>Log the task info only if logging is enabled and the event filter status is set to true.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog.BEGIN_SEND"> <summary>Log the timestamp before sending the message.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog.END_SEND"> <summary>Log the timestamp after sending the message.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog.BEGIN_RECEIVE"> <summary>Log the timestamp before receiving the message.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog.END_RECEIVE"> <summary>Log the timestamp after the message is received.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog.BEFORE_OPEN_QUEUE"> <summary>Log before opening the queue.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog.AFTER_OPEN_QUEUE"> <summary>Log after opening the queue.</summary> </member> <member name="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQLog.TASK_TIMEOUT"> <summary>Log that the task has timed out.</summary> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.ServCompMQTask"> <summary>Contains the service component for the Message Queue task.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.ServCompMQTask.#ctor"> <summary>Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.ServCompMQTask" /> class.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.ServCompMQTask.Execute(Microsoft.SqlServer.Dts.Runtime.Connections,Microsoft.SqlServer.Dts.Runtime.VariableDispenser,Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents,Microsoft.SqlServer.Dts.Runtime.IDTSLogging,System.Object)"> <summary>Runs the task.</summary> <returns>A value from the <see cref="T:Microsoft.SqlServer.Dts.Runtime.DTSExecResult" /> enumeration.</returns> <param name="connections">A collection of connections used by the task.</param> <param name="variableDispenser">A <see cref="T:Microsoft.SqlServer.Dts.Runtime.VariableDispenser" /> object for locking variables.</param> <param name="events">An object implementing the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents" /> interface.</param> <param name="log">An object implementing the <see cref="T:Microsoft.SqlServer.Dts.Runtime.IDTSLogging" /> interface.</param> <param name="transaction">The transaction objects that the container is a part of. The runtime provides the transaction for the container, based on the <see cref="P:Microsoft.SqlServer.Dts.Runtime.DtsContainer.TransactionOption" /> property. This value can be null.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.ServCompMQTask.Initialize(System.String,System.Boolean,System.String,System.String,System.String,System.Boolean,System.String,System.String,System.Int64,Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType,System.Boolean,System.String,Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare,System.String,Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType,System.String,System.String,System.String,Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType,System.Boolean,System.Messaging.EncryptionAlgorithm,System.Boolean,Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask)"> <summary>Initializes the current <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.ServCompMQTask" />.</summary> <param name="desc">The description of the task.</param> <param name="dtFlOvrWrtable">true to indicate that the data file message can overwrite an existing data file; otherwise, false.</param> <param name="MsgLngID">The identifier of the message lineage.</param> <param name="MsgPkgID">The identifier of the package that is the source of the message.</param> <param name="MsgVrsnID">The identifier of the message version.</param> <param name="errIfMsgTmOt">true to indicate that the task fails when the message times out; otherwise, false.</param> <param name="quPath">The path of the queue.</param> <param name="msmqConn">The name of the connection for the MSMQ task.</param> <param name="rcvMsgTmOt">The number of seconds before a received message times out.</param> <param name="rcvMsgTp">The message type to receive.</param> <param name="rmvFromQu">true to remove the message from the queue; otherwise, false.</param> <param name="saveDtFlNm">The name of the file to which an incoming Data File message is saved.</param> <param name="strCmpTp">The string comparison method to use.</param> <param name="strCmpVal">The String to which a string message is compared to when the <see cref="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask.TaskType" /> is <see cref="F:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType.DTSMQType_Receiver" />.</param> <param name="taskTp">The type of the task.</param> <param name="msgDtFl">The name of the data file used.</param> <param name="msgStr">A String that contains the message.</param> <param name="msgVars">The list of variables used in the message.</param> <param name="msgTp">The type of message to send.</param> <param name="useEncrp">true to use encryption; otherwise, false.</param> <param name="encrpAlgthm">The name of the encryption algorithm to use.</param> <param name="use2000Fmt">true to use the SQL Server 2000 format; otherwise, false.</param> <param name="otTask">The specified Message Queue task.</param> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.StringFormatter"> <summary>Represents a string formatter for the message.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.StringFormatter.#ctor"> <summary>Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.StringFormatter" /> class.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.StringFormatter.CanRead(System.Messaging.Message)"> <summary>Indicates whether the message queue can be read.</summary> <returns>true if the message object can be read; otherwise, false.</returns> <param name="msg">The message queue whose readability is in question.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.StringFormatter.Clone"> <summary>Creates a new object that is a copy of the current instance.</summary> <returns>A new object that is a copy of this instance.</returns> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.StringFormatter.Read(System.Messaging.Message)"> <summary>Reads the message.</summary> <returns>An object containing the message.</returns> <param name="msg">The message to read.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.StringFormatter.Write(System.Messaging.Message,System.Object)"> <summary>Opens a memory stream and writes the message object.</summary> <param name="msg">The message objects to write.</param> <param name="obj">The variable that the message object is in.</param> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Variable2KFormatter"> <summary>Represents a variable formatter.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Variable2KFormatter.CanRead(System.Messaging.Message)"> <summary>Determines whether the formatter can read the contents of the message.</summary> <returns>True if the formatter can read the contents of the message; otherwise, false.</returns> <param name="msg">The message to read.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Variable2KFormatter.Clone"> <summary>Creates a copy of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Variable2KFormatter" /> object.</summary> <returns>A copy of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Variable2KFormatter" /> object.</returns> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Variable2KFormatter.Read(System.Messaging.Message)"> <summary>Reads the contents from the given message.</summary> <returns>The contents from the given message.</returns> <param name="msg">The message to read.</param> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Variable2KFormatter.Write(System.Messaging.Message,System.Object)"> <summary>Serializes an object into the body of the message.</summary> <param name="msg">The message whose body property will contain the serialized object.</param> <param name="obj">The object to be serialized into the message.</param> </member> <member name="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Version"> <summary>Represents the task version.</summary> </member> <member name="M:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Version.#ctor(System.String)"> <summary>Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Version" /> class.</summary> <param name="version">The version of the task.</param> </member> <member name="P:Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.Version.DTSVersion"> <summary>Gets or sets the DTS version.</summary> <returns>The DTS version.</returns> </member> </members> </doc>