ScriptTask Kelas

Definisi

Menentukan kelas untuk tugas Skrip, yang memungkinkan pengembang menulis kode kustom untuk melakukan fungsi yang tidak tersedia dalam tugas bawaan yang disediakan oleh Integration Services.

public ref class ScriptTask : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("04FAEAC9-FB98-4F21-8F96-0E857B739740")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[System.Runtime.InteropServices.ComVisible(true)]
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("4DF420FB-D5C2-4357-8FBE-ECB5E15554F8")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[System.Runtime.InteropServices.ComVisible(true)]
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("C2F3965A-3FE3-482B-A6F3-2514B78E149D")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("04FAEAC9-FB98-4F21-8F96-0E857B739740")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist
[<System.Runtime.InteropServices.ComVisible(true)>]
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("4DF420FB-D5C2-4357-8FBE-ECB5E15554F8")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist
[<System.Runtime.InteropServices.ComVisible(true)>]
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("C2F3965A-3FE3-482B-A6F3-2514B78E149D")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist
Public Class ScriptTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist
Warisan
ScriptTask
Atribut
Penerapan

Contoh

Sampel kode berikut, yang diimplementasikan dalam aplikasi konsol ScriptTask , menambahkan ke paket dan menampilkan nilai default dari beberapa propertinya.

using System;  
using Microsoft.SqlServer.Dts.Runtime;  

namespace ScriptTaskCS  
{  
  class Program  
  {  
    static void Main(string[] args)  
    {  
      Package pkg = new Package();  
      string newLine = System.Environment.NewLine;  

      Executable exe = pkg.Executables.Add("STOCK:ScriptTask");  
      TaskHost thTask = (TaskHost)exe;  

      string taskInfo;  
      taskInfo =   

        "Entry point: " +   
        thTask.Properties["EntryPoint"].GetValue(thTask) + newLine +   
        "Script Language: " +   
        thTask.Properties["ScriptLanguage"].GetValue(thTask) + newLine +   
        "ReadOnlyVariables: " +   
        thTask.Properties["ReadOnlyVariables"].GetValue(thTask) + newLine +   
        "ReadWriteVariables: " +   
        thTask.Properties["ReadWriteVariables"].GetValue(thTask);  

      Console.WriteLine(taskInfo);  
      Console.Read();  
    }  
  }  
}  
Imports Microsoft.SqlServer.Dts.Runtime  

Module Module1  

  Sub Main()  

    Dim pkg As New Package  
    Dim newLine As String = System.Environment.NewLine  

    Dim exe As Executable = pkg.Executables.Add("STOCK:ScriptTask")  
    Dim thTask As TaskHost = CType(exe, TaskHost)  

    Dim taskInfo As String  
    taskInfo =   

      "Entry point: " & _  
      thTask.Properties("EntryPoint").GetValue(thTask) & newLine & _  
      "Script Language: " & _  
      thTask.Properties("ScriptLanguage").GetValue(thTask) & newLine & _  
      "ReadOnlyVariables: " & _  
      thTask.Properties("ReadOnlyVariables").GetValue(thTask) & newLine & _  
      "ReadWriteVariables: " & _  
      thTask.Properties("ReadWriteVariables").GetValue(thTask)  

    Console.WriteLine(taskInfo)  
    Console.Read()  

  End Sub  

End Module  

Keterangan

Kelas ScriptTask menentukan tugas Skrip dan menangani interaksi tugas Skrip dengan runtime dan dengan Visual Studio for Applications.

Untuk informasi selengkapnya, lihat Tugas Skrip dan Pengodian dan Penelusuran Kesalahan Tugas Skrip.

Konstruktor

ScriptTask()

Menginisialisasi instans baru kelas ScriptTask.

Properti

BreakpointManager

BreakpointManager Menggunakan untuk mengontrol titik henti pada tugas ini.

Breakpoints

Mendapatkan array titik henti yang diatur pada tugas ini.

DebugMode

Mendapatkan atau menetapkan nilai yang menunjukkan apakah tugas berjalan dalam mode debug, dan apakah tugas harus menaikkan OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) peristiwa saat tugas sedang berjalan.

DefaultActiveItem

Mendapatkan skrip default.

EntryPoint

Mendapatkan atau menetapkan nama kelas yang dijalankan sebagai titik masuk.

ExecutionValue

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

ProjectTemplatePath

Mendapatkan jalur templat proyek yang ditentukan.

ReadOnlyVariables

Mendapatkan atau mengatur daftar variabel yang dibatasi koma yang tersedia untuk paket oleh pengguna untuk akses baca-saja.

ReadWriteVariables

Mendapatkan atau mengatur daftar variabel yang dibatasi koma yang tersedia untuk paket oleh pengguna untuk akses baca/tulis.

ScriptingEngine

VSTATaskScriptingEngine Mendapatkan kelas.

ScriptLanguage

Mendapatkan atau mengatur bahasa pemrograman tempat skrip ditulis.

ScriptLoaded

Mendapatkan nilai yang menunjukkan apakah tugas berisi skrip kustom.

ScriptProjectName

Mendapatkan atau mengatur nama proyek skrip.

ScriptStorage

Mendapatkan VSTAScriptProjectStorage untuk skrip.

SuspendRequired

Mendapatkan atau mengatur Boolean yang menunjukkan apakah tugas harus menangguhkan eksekusi saat tugas mengalami titik henti. Nilai ini diatur oleh mesin run-time untuk tugas dan kontainer saat titik henti ditemui.

TargetServerVersion

Menentukan kelas untuk tugas Skrip, yang memungkinkan pengembang menulis kode kustom untuk melakukan fungsi yang tidak tersedia dalam tugas bawaan yang disediakan oleh Integration Services.

(Diperoleh dari Task)
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 skrip yang terkandung dalam instans Tugas Skrip DTS ini.

Finalize()

Merilis semua sumber daya yang ScriptTaskdigunakan oleh .

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 Skrip. Metode ini dipanggil oleh runtime dan tidak digunakan dalam kode.

LoadFromXML(XmlElement, IDTSInfoEvents)

Menerapkan pemuatan properti dari dokumen XML.

ReportBreakpointChanges()

Melaporkan perubahan titik henti dari tugas.

ResumeExecution()

Melanjutkan eksekusi tugas atau kontainer oleh mesin run-time setelah jeda.

SaveToXML(XmlDocument, IDTSInfoEvents)

Menerapkan penyimpanan properti ke dokumen XML.

SetUniqueScriptProjectName()

Mengatur nama unik proyek skrip.

SuspendExecution()

Menunjukkan bahwa executable harus menangguhkan eksekusi. Metode ini dipanggil oleh mesin run-time.

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 komponen dikonfigurasi dengan benar.

Berlaku untuk