Execute メソッド

メール送信タスクを実行します。

名前空間:  Microsoft.SqlServer.Dts.Tasks.SendMailTask
アセンブリ:  Microsoft.SqlServer.SendMailTask (Microsoft.SqlServer.SendMailTask.dll)

構文

'宣言
Public Overrides Function Execute ( _
    connections As Connections, _
    variableDispenser As VariableDispenser, _
    events As IDTSComponentEvents, _
    log As IDTSLogging, _
    transaction As Object _
) As DTSExecResult
'使用
Dim instance As SendMailTask
Dim connections As Connections
Dim variableDispenser As VariableDispenser
Dim events As IDTSComponentEvents
Dim log As IDTSLogging
Dim transaction As Object
Dim returnValue As DTSExecResult

returnValue = instance.Execute(connections, _
    variableDispenser, events, log, transaction)

public override DTSExecResult Execute(
    Connections connections,
    VariableDispenser variableDispenser,
    IDTSComponentEvents events,
    IDTSLogging log,
    Object transaction
)

public:
virtual DTSExecResult Execute(
    Connections^ connections, 
    VariableDispenser^ variableDispenser, 
    IDTSComponentEvents^ events, 
    IDTSLogging^ log, 
    Object^ transaction
) override

abstract Execute : 
        connections:Connections * 
        variableDispenser:VariableDispenser * 
        events:IDTSComponentEvents * 
        log:IDTSLogging * 
        transaction:Object -> DTSExecResult 
override Execute : 
        connections:Connections * 
        variableDispenser:VariableDispenser * 
        events:IDTSComponentEvents * 
        log:IDTSLogging * 
        transaction:Object -> DTSExecResult 

public override function Execute(
    connections : Connections, 
    variableDispenser : VariableDispenser, 
    events : IDTSComponentEvents, 
    log : IDTSLogging, 
    transaction : Object
) : DTSExecResult

パラメーター

• connections
  型: Microsoft.SqlServer.Dts.Runtime. . :: . .Connections
  タスクで使用される接続のコレクションです。

• variableDispenser
  型: Microsoft.SqlServer.Dts.Runtime. . :: . .VariableDispenser
  変数をロックするための VariableDispenser オブジェクトです。

• events
  型: Microsoft.SqlServer.Dts.Runtime. . :: . .IDTSComponentEvents
  イベントを発生させるための IDTSEvents インターフェイスです。

• log
  型: Microsoft.SqlServer.Dts.Runtime. . :: . .IDTSLogging
  IDTSLogging インターフェイスです。

• transaction
  型: System. . :: . .Object
  コンテナが属するトランザクションです。SSIS ランタイムは、TransactionOption プロパティに基づいて、コンテナのトランザクションを提供します。この値には nullNothingnullptrunitNULL 参照 (Visual Basic では Nothing) を指定できます。

戻り値

型: Microsoft.SqlServer.Dts.Runtime. . :: . .DTSExecResult
DTSExecResult 値のいずれか 1 つです。

説明

Execute メソッドは、DtsContainer クラスを通じてタスク ホストおよび Executable 抽象クラスのその他のオブジェクトにより継承され、継承オブジェクトのランタイム エンジンによる実行を許可します。個々のオブジェクトによって継承された Execute メソッドは通常、コードで使用されません。パッケージでタスクまたはコンテナのいずれかを実行する必要がある場合は、Execute メソッドを呼び出すことをお勧めします。ただし、このメソッドを必要とする特定の状況においては、個々のオブジェクトで Execute メソッドを使用できます。

Execute メソッドは主に、カスタム タスクを作成するときに継承およびオーバーライドするために使用されます。Execute メソッドをオーバーライドする方法の詳細については、「カスタム タスクのコーディング」を参照してください。

Execute メソッドは、パッケージの実行前に暗黙的に Validate メソッドを呼び出します。検証中、パッケージ内のすべてのタスクが適切な設定になっているかが確認され、パッケージ、コンテナ、およびパッケージ内のその他のコンポーネントを含め、パッケージ内のすべてのオブジェクトが検証されます。

検証フェーズにパッケージが失敗する原因となるような問題が存在しない場合、パッケージ オブジェクトはパッケージ内の各タスクとオブジェクトごとに Execute メソッドを呼び出します。

TransactionOption プロパティが false である場合、transaction パラメータには null Nothing nullptr unit NULL 参照 (Visual Basic では Nothing) を渡します。TransactionOption プロパティが true の場合は、transaction パラメータに null Nothing nullptr unit NULL 参照 (Visual Basic では Nothing) を渡して、コンテナがトランザクションをサポートしているが参加していないことを示すことができます。

使用例

タスクの一部のプロパティを設定した後に BulkInsertTask を含むパッケージを実行するコード例を次に示します。一括挿入タスクはこのコード サンプルの一例です。どのタスクも適宜作成できます。

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.BulkInsertTask

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Package p = new Package();
            p.InteractiveMode = true;
            p.OfflineMode = true;
            Executable exec1 = pkg.Executables.Add("STOCK:BulkInsertTask");
            TaskHost th = exec1 as TaskHost;

            // Set the CheckConstraints and DataFileType properties.           
            th.Properties["CheckConstraints"].SetValue(th, true);
            th.Properties["DataFileType"].SetValue(th, DTSBulkInsert_DataFileType.DTSBulkInsert_DataFileType_Native);
           
            // Run the package that contains the task.
            pkg.Execute();

            // Review the results of the run.
            if (taskH.ExecutionResult == DTSExecResult.Failure || taskH.ExecutionStatus == DTSExecStatus.Abend)
                Console.WriteLine("Task failed or abended");
            else
                Console.WriteLine("Task ran successfully");
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.BulkInsertTask
 
Namespace Microsoft.SqlServer.SSIS.Samples
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim p As Package =  New Package() 
            p.InteractiveMode = True
            p.OfflineMode = True
            Dim exec1 As Executable =  pkg.Executables.Add("STOCK:BulkInsertTask") 
            Dim th As TaskHost =  exec1 as TaskHost 
 
            ' Set the CheckConstraints and DataFileType properties.           
            th.Properties("CheckConstraints").SetValue(th, True)
            th.Properties("DataFileType").SetValue(th, DTSBulkInsert_DataFileType.DTSBulkInsert_DataFileType_Native)
 
            ' Run the package that contains the task.
            pkg.Execute()
 
            ' Review the results of the run.
            If taskH.ExecutionResult = DTSExecResult.Failure Or taskH.ExecutionStatus = DTSExecStatus.Abend Then
                Console.WriteLine("Task failed or abended")
            Else 
                Console.WriteLine("Task ran successfully")
            End If
        End Sub
    End Class
End Namespace

関連項目

参照

SendMailTask クラス

Microsoft.SqlServer.Dts.Tasks.SendMailTask 名前空間