• Article

DtsEventHandler.SetExpression Method

Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property.

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public Sub SetExpression ( _
    propertyName As String, _
    expression As String _
)
'Usage
Dim instance As DtsEventHandler
Dim propertyName As String
Dim expression As String

instance.SetExpression(propertyName, _
    expression)

public void SetExpression(
    string propertyName,
    string expression
)

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

abstract SetExpression : 
        propertyName:string * 
        expression:string -> unit 
override SetExpression : 
        propertyName:string * 
        expression:string -> unit 

public final function SetExpression(
    propertyName : String, 
    expression : String
)

Parameters

  • propertyName
    Type: System.String
    The name of the property to which to assign the expression.

Implements

IDTSPropertiesProvider.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