Package.GetBreakpointTargets メソッド

BreakpointTargets コレクションを返します。 onlyEnabled パラメーターの設定により、コレクションには、パッケージ内のすべてのブレークポイント ターゲットが含まる場合と、有効なブレークポイント ターゲットのみが含まれる場合があります。

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

構文

'宣言
Public Function GetBreakpointTargets ( _
    bpSite As IDTSBreakpointSite, _
    onlyEnabled As Boolean _
) As BreakpointTargets
'使用
Dim instance As Package 
Dim bpSite As IDTSBreakpointSite 
Dim onlyEnabled As Boolean 
Dim returnValue As BreakpointTargets 

returnValue = instance.GetBreakpointTargets(bpSite, _
    onlyEnabled)
public BreakpointTargets GetBreakpointTargets(
    IDTSBreakpointSite bpSite,
    bool onlyEnabled
)
public:
BreakpointTargets^ GetBreakpointTargets(
    IDTSBreakpointSite^ bpSite, 
    bool onlyEnabled
)
member GetBreakpointTargets : 
        bpSite:IDTSBreakpointSite * 
        onlyEnabled:bool -> BreakpointTargets
public function GetBreakpointTargets(
    bpSite : IDTSBreakpointSite, 
    onlyEnabled : boolean
) : BreakpointTargets

パラメーター

  • onlyEnabled
    型: System.Boolean
    コレクションに含めるブレークポイント ターゲットの種類を示す Boolean です。 true は有効なブレークポイントのみがコレクションに含まれることを示し、false はすべてのブレークポイント ターゲットがコレクションに含まれることを示します。

戻り値

型: Microsoft.SqlServer.Dts.Runtime.BreakpointTargets
BreakpointTargets コレクションです。

説明

onlyenabled パラメーターは、true に設定すると、Enabled プロパティの値を確認し、Enabled が true に設定されたそれらのブレークポイントを含めます。

Integration Services (SSIS) では、コンテナーおよびタスクに対してブレークポイントをサポートしています。 SQL Server データ ツール (SSDT) にはデバッグ ウィンドウが用意されており、SSIS デザイナーにはパッケージ制御フローのデバッグの進行状況レポートが用意されています。 SSIS デザイナーには、[ブレークポイントの設定] ダイアログ ボックスが用意されており、ここで、ブレークポイントを有効にし、ランタイム エンジンが停止するまでに発生するブレークポイントの回数を設定できます。 タスク ブレークポイントが有効な場合、ブレークポイント アイコンが [制御フロー] ウィンドウのデザイン画面のタスクの横に表示されます。 イベントで発生するブレークポイントを設定できます。 イベントでのブレークポイントの設定の詳細については、「Integration Services (SSIS) のイベント ハンドラー」を参照してください。

使用例

次のコード サンプルでは、パッケージでブレークポイントのコレクションを取得するための GetBreakpointTargets の使用方法を示します。

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

namespace Breakpoint_API
{
    class Program
    {
        static void Main(string[] args)
        {
            Package pkg = new Package();
            TaskHost taskHost = (TaskHost)pkg.Executables.Add("STOCK:FileSystemTask");
            BreakpointTargets bptargets = pkg.GetBreakpointTargets(taskHost, false);
            foreach (BreakpointTarget bpt in bptargets)
            {
                Console.WriteLine("BreakOnExpressionChange? {0}", bpt.BreakOnExpressionChange.ToString());
                Console.WriteLine("Description              {0}", bpt.Description);
                Console.WriteLine("Enabled?                 {0}", bpt.Enabled);
                Console.WriteLine("HitCount                 {0}", bpt.HitCount);
                Console.WriteLine("HitTarget                {0}", bpt.HitTarget);
                Console.WriteLine("HitTest                  {0}", bpt.HitTest);
                Console.WriteLine("ID                       {0}", bpt.ID);
                Console.WriteLine("Owner                    {0}", bpt.Owner);
            }
        }
    }
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.BulkInsertTask
 
Namespace Breakpoint_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim pkg As Package =  New Package() 
            Dim taskHost As TaskHost = CType(pkg.Executables.Add("STOCK:FileSystemTask"), TaskHost)
            Dim bptargets As BreakpointTargets =  pkg.GetBreakpointTargets(taskHost,False) 
            Dim bpt As BreakpointTarget
            For Each bpt In bptargets
                Console.WriteLine("BreakOnExpressionChange? {0}", bpt.BreakOnExpressionChange.ToString())
                Console.WriteLine("Description              {0}", bpt.Description)
                Console.WriteLine("Enabled?                 {0}", bpt.Enabled)
                Console.WriteLine("HitCount                 {0}", bpt.HitCount)
                Console.WriteLine("HitTarget                {0}", bpt.HitTarget)
                Console.WriteLine("HitTest                  {0}", bpt.HitTest)
                Console.WriteLine("ID                       {0}", bpt.ID)
                Console.WriteLine("Owner                    {0}", bpt.Owner)
            Next
        End Sub
    End Class
End Namespace

サンプルの出力:

BreakOnExpressionChange? False

Description Break when the container receives the OnPreExecute event

Enabled? False

HitCount 0

HitTarget 0

HitTest Always

ID -2147483647

Owner Microsoft.SqlServer.Dts.Runtime.TaskHost

関連項目

参照

Package クラス

Microsoft.SqlServer.Dts.Runtime 名前空間