MessageQueueTask クラス

継承階層

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

構文

'宣言
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 クラスの新しいインスタンスを初期化します。

先頭に戻る

プロパティ

	名前	説明
	CurrentExecutingPackageID	現在実行中のパッケージの ID を取得します。値の設定も可能です。
	DataFileOverWritable	データ ファイル メッセージが既存のデータ ファイルを上書きできるかどうかを示す Boolean を取得します。値の設定も可能です。
	DebugMode	オブジェクトがデバッグ モードであるかどうか、および実行中に OnBreakpointHit イベントを発生させる必要があるかどうかを示す Boolean を取得します。値の設定も可能です。
	DTSMessageLineageID	メッセージ系列 ID を取得します。値の設定も可能です。
	DTSMessagePackageID	メッセージのソースであるパッケージの識別子を取得します。値の設定も可能です。
	DTSMessageVersionID	メッセージのバージョンを取得します。値の設定も可能です。
	EncryptionAlgo	プライベート メッセージのメッセージ本文を暗号化するために使用される暗号化アルゴリズムの名前を取得します。値の設定も可能です。
	ErrorIfMessageTimeOut	メッセージがタイムアウトしたときにタスクが失敗するかどうかを指定する Boolean を取得します。値の設定も可能です。
	ExecutionValue	ユーザー定義のオブジェクトを返します。このフィールドは読み取り専用です。 (Task から継承されています。)
	MessageDataFile	MessageType が DTSMQMessageType_DataFile に設定されている場合に使用されるデータ ファイル名を取得します。値の設定も可能です。
	MessageString	MessageType が DTSMQMessageType_String に設定されている場合に使用されるメッセージを取得します。値の設定も可能です。
	MessageType	TaskType が DTSMQType_Sender である場合に送信されているメッセージの種類を示す値を取得します。値の設定も可能です。
	MessageVariables	MQMessageType 列挙が DTSMQMessageType_Variables に設定されている場合の変数一覧を取得します。値の設定も可能です。
	MsmqConnection	MSMQ タスクが使用する接続の名前を取得します。値の設定も可能です。
	OperationDescription	操作の説明を取得します。値の設定も可能です。
	ReceiveMessageTimeOut	受信メッセージがタイムアウトするまでの秒数を示す値を取得します。値の設定も可能です。
	ReceiveMessageType	受信するメッセージの種類を示す MQMessageType 値を取得します。値の設定も可能です。
	ReceiveVariableMessage	メッセージを格納する変数の名前を取得します。値の設定も可能です。
	RemoveFromQueue	メッセージをキューから削除する必要があるかどうかを指定する Boolean を取得します。値の設定も可能です。
	SaveDataFileName	着信データ ファイル メッセージが保存されるファイルの名前を取得します。値の設定も可能です。
	StringCompareType	TaskType が DTSMQType_Receiver である場合の String のメッセージの種類に対して文字列比較のメソッドを指定する値です。
	StringCompareValue	TaskType が DTSMQType_Receiver である場合に、文字列メッセージの比較対象となる String を取得します。値の設定も可能です。
	StringMessageToVariableName	メッセージの内容が保存される変数の名前を取得します。値の設定も可能です。
	SuspendRequired	ブレークポイントに到達したときにタスクを中断するかどうかを示す Boolean を取得します。値の設定も可能です。この値は、ブレークポイントに到達したときにタスクおよびコンテナに対してランタイム エンジンで設定されます。
	TaskType	メッセージ タスクが送信と受信のどちらを実行しているかを示す値を取得します。値の設定も可能です。
	Use2000Format	メッセージで SQL Server 2000 形式を使用するかどうかを示す Boolean を取得します。値の設定も可能です。
	UseEncryption	メッセージで暗号化を使用するかどうかを示す Boolean を取得します。値の設定も可能です。
	Version	*** このメンバーは非推奨です。「解説」を参照してください。 ***    タスクのバージョンを返します。このプロパティは読み取り専用です。 (Task から継承されています。)

先頭に戻る

メソッド

	名前	説明
	AcceptBreakpointManager	タスクに BreakpointManager を渡します。このメソッドはランタイムから呼び出されるメソッドであり、コードでは使用されません。
	CanUpdate	*** このメンバーは非推奨です。「解説」を参照してください。 ***    新しいパッケージの XML で古いパッケージの XML を更新できるかどうかを示す Boolean 値。 (Task から継承されています。)
	Equals	2 つのオブジェクト インスタンスが等しいかどうかを示します。 (DtsObject から継承されています。)
	Execute	タスクを実行します。 (Task. . :: . .Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) をオーバーライドします。)
	Finalize	(Object から継承されています。)
	GetConnectionID	接続の ID を含む String を取得します。 (Task から継承されています。)
	GetConnectionName	接続の名前を含む String を取得します。 (Task から継承されています。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 (DtsObject から継承されています。)
	GetType	(Object から継承されています。)
	InitializeTask	タスクに関連付けられたプロパティを初期化します。このメソッドはランタイムから呼び出されるメソッドであり、コードでは使用されません。 (Task. . :: . .InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) をオーバーライドします。)
	LoadFromXML	このメソッドをアプリケーション コードから呼び出すことはできません。XML 形式 (ファイル名拡張子 .xml) で保存されたパッケージを読み込むには、Application..::..LoadPackage メソッドを使用します。
	MemberwiseClone	(Object から継承されています。)
	ResumeExecution	一時停止したタスクの実行を再開します。タスクまたはコンテナの実行は、ランタイム エンジンによって再開されます。
	SaveToXML	このメソッドをアプリケーション コードから呼び出すことはできません。パッケージを .xml として保存するには、Application..::..SaveToXml メソッドを使用します。
	SuspendExecution	実行可能ファイルを中断する必要があることを示します。このメソッドはランタイム エンジンから呼び出されます。
	ToString	(Object から継承されています。)
	Update	*** このメンバーは非推奨です。「解説」を参照してください。 ***    CanUpdate が true に設定されている場合、このメソッドによって、古いパッケージ XML が新しいパッケージ XML で更新されます。 (Task から継承されています。)
	Validate	タスクが正しく構成されていることを確認します。 (Task. . :: . .Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) をオーバーライドします。)

先頭に戻る

説明

メッセージ キュー タスク クラスを使用すると、オブジェクトは、メッセージ キュー (MSMQ) のキューとの間でメッセージを送受信できます。Microsoft 分散トランザクション コーディネータ (MSDTC) を実行している場合は、分散トランザクションへの参加が可能です。メッセージ キュー タスクの単一のインスタンスは、指定したキューに 1 つのメッセージを送信するか、指定したキューから単一のメッセージを受信し、必要に応じてメッセージの到着を待機します。次の種類のメッセージを送信できます。

• プロパティの値として提供される文字列メッセージです。

• 指定したデータ ファイルの内容から生成されたデータ ファイル メッセージです。

• 1 つ以上の SQL Server Integration Services 変数の名前と値から生成された変数メッセージです。

MQMessageType 列挙によって、特定のメッセージ キュー タスクで使用されるメッセージ形式が決まります。

詳細については、「メッセージ キュー タスク」を参照してください。

MessageQueueTask を API または SSIS デザイナで使用するためには、SQL Server Integration Services をインストールする必要があります。この機能は、Business Intelligence Development Studio のみがインストールされている場合は使用できません。

重要
メッセージ キュー タスクを構成してメッセージを送信する場合、メッセージ キューで現在サポートされている暗号化アルゴリズム (RC2 および RC4) のいずれかを使用してメッセージを暗号化できます。現在、いずれの暗号化アルゴリズムも、メッセージ キューでまだサポートされていない最新のアルゴリズムと比較して、暗号強度の弱さが指摘されています。そのため、メッセージ キュー タスクを使ってメッセージを送信する場合は、必要な暗号強度を満たすことができるかどうかを十分に検討する必要があります。

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

関連項目

参照