DtsEventHandler.GetPackagePath Method

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets the path of the package that the event handler applies to.

public:
 virtual System::String ^ GetPackagePath();

public string GetPackagePath ();

abstract member GetPackagePath : unit -> string
override this.GetPackagePath : unit -> string

Public Function GetPackagePath () As String

Returns

String

A String that contains the package path.

Implements

GetPackagePath()

Examples

The following code example creates a DtsEventHandler for the package, and shows the package path.

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

namespace Microsoft.SqlServer.SSIS.Samples  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            Package pkg = new Package();  
            DtsEventHandler dtsEH = (DtsEventHandler)pkg.EventHandlers.Add("OnError");  
            dtsEH.Executables.Add("STOCK:SendMailTask");  

            // View the package path for the DtsEventHandler container.  
            Console.WriteLine("Package Path of DtsEventHandler: {0}", dtsEH.GetPackagePath());  
        }  
    }  
}  

Imports System  
Imports System.Collections.Generic  
Imports System.Text  
Imports Microsoft.SqlServer.Dts.Runtime  

Namespace Microsoft.SqlServer.SSIS.Samples  
    Class Program  
        Shared  Sub Main(ByVal args() As String)  
            Dim pkg As Package =  New Package()   
            Dim dtsEH As DtsEventHandler = CType(pkg.EventHandlers.Add("OnError"), DtsEventHandler)  
            dtsEH.Executables.Add("STOCK:SendMailTask")  

            ' View the package path for the DtsEventHandler container.  
            Console.WriteLine("Package Path of DtsEventHandler: {0}", dtsEH.GetPackagePath())  
        End Sub  
    End Class  
End Namespace  

Sample Output:

Package Path of DtsEventHandler: \Package.EventHandlers[OnError]