다음을 통해 공유


MessageQueueTask 클래스

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

상속 계층

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask

네임스페이스:  Microsoft.SqlServer.Dts.Tasks.MessageQueueTask
어셈블리:  Microsoft.SqlServer.MSMQTask(Microsoft.SqlServer.MSMQTask.dll)

구문

‘선언
Public NotInheritable Class MessageQueueTask _
    Inherits Task _
    Implements IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
‘사용 방법
Dim instance As MessageQueueTask
public sealed class MessageQueueTask : Task, 
    IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
public ref class MessageQueueTask sealed : public Task, 
    IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
[<SealedAttribute>]
type MessageQueueTask =  
    class 
        inherit Task 
        interface IDTSComponentPersist 
        interface IMessageQueueTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
    end
public final class MessageQueueTask extends Task implements IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend

MessageQueueTask 유형에서 다음 멤버를 표시합니다.

생성자

  이름 설명
공용 메서드 MessageQueueTask Initializes a new instance of the MessageQueueTask class.

맨 위로 이동

속성

  이름 설명
공용 속성 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. (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 *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Task에서 상속됨)

맨 위로 이동

메서드

  이름 설명
공용 메서드 AcceptBreakpointManager Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.
공용 메서드 CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Task에서 상속됨)
공용 메서드 Equals Determines whether two object instances are equal. (DtsObject에서 상속됨)
공용 메서드 Execute Runs the task. (Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)을(를) 재정의함)
공용 메서드 GetConnectionID Gets a String containing the ID of the connection. (Task에서 상속됨)
공용 메서드 GetConnectionName Gets a String containing the name of the connection. (Task에서 상속됨)
공용 메서드 GetHashCode Returns the hash code for this instance. (DtsObject에서 상속됨)
공용 메서드 GetType (Object에서 상속됨)
공용 메서드 InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)을(를) 재정의함)
공용 메서드 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.
공용 메서드 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 (Object에서 상속됨)
공용 메서드 Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (Task에서 상속됨)
공용 메서드 Validate Verifies that the task is properly configured. (Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)을(를) 재정의함)

맨 위로 이동

주의

The Message Queue task class allows an object to send and receive messages to or from a queue of Message Queuing (also known as MSMQ). Participation in distributed transactions is allowed when running the Microsoft Distributed Transaction Coordinator (MSDTC). A single instance of a Message Queue task either sends one message to a specified queue or receives a single message from a specified queue, and also waits, if necessary, for the message to arrive. The following types of messages can be sent:

  • A string message, which is supplied as the value of a property.

  • A data file message, which is generated from the contents of a specified data file.

  • A variables message, which is generated from the names and values of one or more SQL Server Integration Services variables.

The enumeration MQMessageType determines which message format is used by a specific Message Queue task.

For more information, see 메시지 큐 태스크.

For the MessageQueueTask to work in either the API or in SSIS Designer, you must install SQL Server Integration Services. This feature will not work if only SQL Server Data Tools(SSDT) is installed.

중요 정보중요

When configuring the Message Queue task to send messages, you can use one of the encryption algorithms that are currently supported by the Message Queuing, RC2 and RC4, to encrypt the message. Both of these encryption algorithms are now considered cryptographically weak compared to newer algorithms, which Message Queuing does not yet support. Therefore, you should consider your cryptography needs carefully when sending messages using the Message Queue task.

스레드 보안

이 유형의 모든 공용 static(Visual Basic에서는 Shared) 멤버는 스레드로부터 안전합니다. 인스턴스 멤버는 스레드로부터의 안전성이 보장되지 않습니다.

참고 항목

참조

Microsoft.SqlServer.Dts.Tasks.MessageQueueTask 네임스페이스