MessageQueueTask Kelas

Definisi

Berisi metode dan properti yang digunakan oleh tugas Antrean Pesan. Kelas ini tidak dapat diwariskan.

public ref class MessageQueueTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::MessageQueueTask::IMessageQueueTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IMessageQueueTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IMessageQueueTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IMessageQueueTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
Public NotInheritable Class MessageQueueTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IMessageQueueTask
Warisan
MessageQueueTask
Atribut
Penerapan

Keterangan

Kelas tugas Antrean Pesan memungkinkan objek mengirim dan menerima pesan ke atau dari antrean Antrean Pesan (juga dikenal sebagai MSMQ). Partisipasi dalam transaksi terdistribusi diizinkan saat menjalankan Koordinator Transaksi Terdistribusi Microsoft (MSDTC). Satu instans tugas Antrean Pesan mengirim satu pesan ke antrean tertentu atau menerima satu pesan dari antrean tertentu, dan juga menunggu, jika perlu, agar pesan tiba. Jenis pesan berikut dapat dikirim:

  • Pesan string, yang disediakan sebagai nilai properti.

  • Pesan file data, yang dihasilkan dari konten file data tertentu.

  • Pesan variabel, yang dihasilkan dari nama dan nilai satu atau beberapa variabel SQL Server Integration Services.

Enumerasi MQMessageType menentukan format pesan mana yang digunakan oleh tugas Antrean Pesan tertentu.

Untuk informasi selengkapnya, lihat Tugas Antrean Pesan.

MessageQueueTask Agar berfungsi di API atau di SSIS Designer, Anda harus menginstal SQL Server Integration Services. Fitur ini tidak akan berfungsi jika hanya SQL Server Data Tools (SSDT) yang diinstal.

Penting

Saat mengonfigurasi tugas Antrean Pesan untuk mengirim pesan, Anda dapat menggunakan salah satu algoritma enkripsi yang saat ini didukung oleh Antrean Pesan, RC2 dan RC4, untuk mengenkripsi pesan. Kedua algoritma enkripsi ini sekarang dianggap lemah secara kriptografis dibandingkan dengan algoritma yang lebih baru, yang belum didukung oleh Antrean Pesan. Oleh karena itu, Anda harus mempertimbangkan kebutuhan kriptografi Anda dengan hati-hati saat mengirim pesan menggunakan tugas Antrean Pesan.

Konstruktor

MessageQueueTask()

Menginisialisasi instans baru kelas MessageQueueTask.

Properti

CurrentExecutingPackageID

Mendapatkan atau mengatur ID paket eksekusi saat ini.

DataFileOverWritable

Mendapatkan atau mengatur Boolean yang menunjukkan apakah pesan file data dapat menimpa file data yang ada.

DebugMode

Mendapatkan atau mengatur Boolean yang menunjukkan apakah objek berada dalam mode debug, dan apakah objek harus menaikkan OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) peristiwa saat berjalan.

DTSMessageLineageID

Mendapatkan atau mengatur pengidentifikasi silsilah pesan.

DTSMessagePackageID

Mendapatkan atau mengatur pengidentifikasi paket yang merupakan sumber pesan.

DTSMessageVersionID

Mendapatkan atau mengatur versi pesan.

EncryptionAlgo

Mendapatkan atau mengatur nama algoritma enkripsi yang digunakan untuk mengenkripsi isi pesan pesan privat.

ErrorIfMessageTimeOut

Mendapatkan atau mengatur Boolean yang menentukan apakah tugas gagal saat pesan kehabisan waktu.

ExecutionValue

Mengembalikan objek yang ditentukan pengguna. Bidang ini hanya-baca.

(Diperoleh dari Task)
MessageDataFile

Mendapatkan atau mengatur nama file data yang digunakan saat MessageType diatur ke DTSMQMessageType_DataFile.

MessageString

Mendapatkan atau mengatur pesan yang akan digunakan saat MessageType diatur ke DTSMQMessageType_String.

MessageType

Mendapatkan atau menetapkan nilai yang menunjukkan jenis pesan yang dikirim saat TaskType adalah DTSMQType_Sender.

MessageVariables

Mendapatkan atau mengatur daftar variabel saat MQMessageType enumerasi diatur ke DTSMQMessageType_Variables.

MsmqConnection

Mendapatkan atau mengatur nama koneksi untuk tugas MSMQ.

OperationDescription

Mendapatkan atau mengatur deskripsi operasi.

ReceiveMessageTimeOut

Mendapatkan atau menetapkan nilai yang menentukan jumlah detik sebelum waktu pesan yang diterima habis.

ReceiveMessageType

Mendapatkan atau menetapkan MQMessageType nilai yang menunjukkan jenis pesan yang akan diterima.

ReceiveVariableMessage

Mendapatkan atau mengatur nama variabel untuk menyimpan pesan.

RemoveFromQueue

Mendapatkan atau mengatur Boolean yang menentukan apakah pesan harus dihapus dari antrean.

SaveDataFileName

Mendapatkan atau mengatur nama file tempat pesan File Data masuk disimpan.

StringCompareType

Nilai yang menentukan metode perbandingan string untuk jenis pesan String saat TaskType adalah DTSMQType_Receiver.

StringCompareValue

Mendapatkan atau mengatur String tempat pesan string dibandingkan dengan saat TaskType adalah DTSMQType_Receiver.

StringMessageToVariableName

Mendapatkan atau mengatur nama variabel tempat konten pesan disimpan.

SuspendRequired

Mendapatkan atau mengatur Boolean yang menunjukkan apakah tugas harus ditangguhkan saat menemukan titik henti. Nilai ini diatur oleh mesin runtime untuk tugas dan kontainer saat titik henti ditemui.

TargetServerVersion

Berisi metode dan properti yang digunakan oleh tugas Antrean Pesan. Kelas ini tidak dapat diwariskan.

(Diperoleh dari Task)
TaskType

Mendapatkan atau menetapkan nilai yang menunjukkan apakah tugas pesan dikirim atau diterima.

Use2000Format

Mendapatkan atau mengatur Boolean yang menunjukkan bahwa pesan menggunakan format SQL Server 2000.

UseEncryption

Mendapatkan atau mengatur Boolean yang menunjukkan apakah pesan menggunakan enkripsi.

Version

Anggota tidak digunakan lagi; lihat Keterangan. Mengembalikan versi tugas. Properti ini bersifat hanya baca.

(Diperoleh dari Task)

Metode

AcceptBreakpointManager(BreakpointManager)

Meneruskan BreakpointManager ke tugas. Metode ini dipanggil oleh runtime dan tidak digunakan dalam kode.

CanUpdate(String)

Anggota tidak digunakan lagi; lihat Keterangan. Boolean yang menunjukkan apakah XML paket baru dapat memperbarui XML paket lama.

(Diperoleh dari Task)
Equals(Object)

Menentukan apakah dua instans objek sama.

(Diperoleh dari DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Menjalankan tugas.

GetConnectionID(Connections, String)

Mendapatkan String yang berisi ID koneksi.

(Diperoleh dari Task)
GetConnectionName(Connections, String)

Mendapatkan String yang berisi nama koneksi.

(Diperoleh dari Task)
GetHashCode()

Mengembalikan kode hash untuk instans ini.

(Diperoleh dari DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Menginisialisasi properti yang terkait dengan tugas. Metode ini dipanggil oleh runtime dan tidak digunakan dalam kode.

LoadFromXML(XmlElement, IDTSInfoEvents)

Metode ini tidak dapat dipanggil oleh kode aplikasi Anda. Untuk memuat paket yang disimpan dalam format XML (dengan ekstensi nama file the.xml), gunakan metode .LoadPackage(String, IDTSEvents)

ResumeExecution()

Melanjutkan eksekusi tugas setelah jeda. Eksekusi tugas atau kontainer dilanjutkan oleh mesin runtime.

SaveToXML(XmlDocument, IDTSInfoEvents)

Metode ini tidak dapat dipanggil oleh kode aplikasi Anda. Untuk menyimpan paket sebagai .xml, gunakan metode .SaveToXml(String, Package, IDTSEvents)

SuspendExecution()

Menunjukkan bahwa executable perlu ditangguhkan. Metode ini dipanggil oleh mesin runtime.

Update(String)

Anggota tidak digunakan lagi; lihat Keterangan. Metode ini memperbarui XML paket lama dengan XML paket baru jika CanUpdate(String) diatur ke true.

(Diperoleh dari Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Memverifikasi bahwa tugas dikonfigurasi dengan benar.

Berlaku untuk