BreakpointTarget.Description Property

Returns the description associated with the breakpoint.

Espacio de nombres: Microsoft.SqlServer.Dts.Runtime
Ensamblado: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Sintaxis

'Declaración
Public ReadOnly Property Description As String

public string Description { get; }

public:
property String^ Description {
    String^ get ();
}

/** @property */
public String get_Description ()

public function get Description () : String

Valor de propiedad

A String containing a description for the breakpoint.

Ejemplo

The following code example retrieves the breakpoint target collection from the package and iterates through the breakpoints, displaying the properties for each breakpoint, including the Description.

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

Sample Output:

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

Seguridad para subprocesos

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Plataformas

Plataformas de desarrollo

Para obtener una lista de las plataformas compatibles, vea Requisitos de hardware y software para instalar SQL Server 2005.

Plataformas de destino

Para obtener una lista de las plataformas compatibles, vea Requisitos de hardware y software para instalar SQL Server 2005.

Vea también

Referencia

BreakpointTarget Class
BreakpointTarget Members
Microsoft.SqlServer.Dts.Runtime Namespace