DtsEventHandler.SetExpression(String, String) Method

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

public:
 virtual void SetExpression(System::String ^ propertyName, System::String ^ expression);

public void SetExpression (string propertyName, string expression);

abstract member SetExpression : string * string -> unit
override this.SetExpression : string * string -> unit

Public Sub SetExpression (propertyName As String, expression As String)

Parameters

propertyName

String

The name of the property to which to assign the expression.

expression

String

The expression.

Implements

SetExpression(String, String)

Examples

The following code example creates a package and adds a DtsEventHandler for the package OnError event. Using the SetExpression, the FailParentOnFailure property is modified. Using the GetExpression method, the new value and associated expression are displayed.

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

namespace Microsoft.SqlServer.SSIS.Sample  
{  
    class SSISProgram  
    {  
        static void Main(string[] args)  
        {  
            Package pkg = new Package();  
            // Set up a DtsEventHandler for the package OnError event.  
            DtsEventHandler dtsEH = (DtsEventHandler)pkg.EventHandlers.Add("OnError");  

            // Show the value of DebugMode on the container before modifying it.  
            Console.WriteLine("Original FailParentOnFailure = {0}", dtsEH.FailParentOnFailure);  

            // Use SetExpression to set DebugMode to "true".  
            String myExpression = "True";  
            dtsEH.SetExpression("FailParentOnFailure", myExpression);  

            //Validate the package to set the expression onto the property.  
            DTSExecResult valResult = pkg.Validate(null, null, null, null);  

            // Retrieve the new value and the expression.  
            String myNewExpression = dtsEH.GetExpression("FailParentOnFailure");  
            Console.WriteLine("New value of FailParentOnFailure: {0}", dtsEH.FailParentOnFailure);  
            Console.WriteLine("Expression for FailParentOnFailure: {0}", myNewExpression);  
        }  
    }  
}  

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

Class SSISProgram  

    Shared Sub Main(ByVal args() As String)   
        Dim pkg As New Package()  
        ' Set up a DtsEventHandler for the package OnError event.  
        Dim dtsEH As DtsEventHandler = CType(pkg.EventHandlers.Add("OnError"), DtsEventHandler)  

        ' Show the value of DebugMode on the container before modifying it.  
        Console.WriteLine("Original FailParentOnFailure = {0}", dtsEH.FailParentOnFailure)  

        ' Use SetExpression to set DebugMode to "true".  
        Dim myExpression As String = "True"  
        dtsEH.SetExpression("FailParentOnFailure", myExpression)  

        'Validate the package to set the expression onto the property.  
        Dim valResult As DTSExecResult = pkg.Validate(Nothing, Nothing, Nothing, Nothing)  

        ' Retrieve the new value and the expression.  
        Dim myNewExpression As String = dtsEH.GetExpression("FailParentOnFailure")  
        Console.WriteLine("New value of FailParentOnFailure: {0}", dtsEH.FailParentOnFailure)  
        Console.WriteLine("Expression for FailParentOnFailure: {0}", myNewExpression)  

    End Sub 'Main  
End Class  

Sample Output:

Original FailParentOnFailure = False

New value of FailParentOnFailure: True

Expression for FailParentOnFailure: True