ForEachEnumeratorHost.GetExpression(String) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a String that contains the expression for the specified property. Null means no expression is assigned.

public:
 virtual System::String ^ GetExpression(System::String ^ propertyName);

public string GetExpression (string propertyName);

abstract member GetExpression : string -> string
override this.GetExpression : string -> string

Public Function GetExpression (propertyName As String) As String

Parameters

propertyName: String

The name of the property whose expression you want to see.

Returns

String

A String that contains the expression used to evaluate the property.

Implements

GetExpression(String)

Examples

The following code example hosts a SMO enumerator in the ForEachEnumeratorHost. Using the SetExpression method, the DelayValidation property is modified, then the expression is retrieved using the GetExpression method.

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

namespace Microsoft.SqlServer.SSIS.Sample  
{  
    internal class EnumType  
    {  
        public const string SMOEnum = "Foreach SMO Enumerator";  
    }  
    class SSISProgram  
    {  
        static void Main(string[] args)  
        {  
            Application app = new Application();  
            Package pkg = new Package();  
            ForEachEnumeratorInfos infos = app.ForEachEnumeratorInfos;  
            ForEachEnumeratorInfo info = null;  

            foreach (ForEachEnumeratorInfo enumInfo in infos)  
            {  
                // Uncomment the next line of you want to see all enumerators.  
                //Console.Write("Available enumerators: {0}\n", enumInfo.Name);  
                if (enumInfo.Name == EnumType.SMOEnum)  
                {  
                    // Set the ForEachEnumeratorInfo variable  
                    // to the SMO enumerator, and use it   
                    // later in the CreateNew method.  
                    info = enumInfo;  
                }  
            }  
            ForEachEnumeratorHost enumH = info.CreateNew();  
            Console.WriteLine();  
            // Show the description before it is modified.  
            Console.WriteLine("DelayValidation:  {0}", enumH.DelayValidation);  

            // Modify the Description using SetExpression.  
            //String myExpression = "\"My Description for SMO enumerator\"";  
            String myExpression = "true";  
            enumH.SetExpression("DelayValidation", myExpression);  

            DTSExecResult result = pkg.Validate(null, null, null, null);  

            // Review the new value and expression.  
            String newExpr = enumH.GetExpression("DelayValidation");  
            Console.WriteLine("New DelayValidation: {0}", enumH.DelayValidation);  
            Console.WriteLine("Expression:      {0}", newExpr);  
        }  
    }  
}

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

Friend Class EnumType  
    Public Const SMOEnum As String = "Foreach SMO Enumerator"  
End Class 'EnumType  

Class SSISProgram  

    Shared Sub Main(ByVal args() As String)   
        Dim app As New Application()  
        Dim pkg As New Package()  
        Dim infos As ForEachEnumeratorInfos = app.ForEachEnumeratorInfos  
        Dim info As ForEachEnumeratorInfo = Nothing  

        Dim enumInfo As ForEachEnumeratorInfo  
        For Each enumInfo In  infos  
            ' Uncomment the next line of you want to see all enumerators.  
            'Console.Write("Available enumerators: {0}\n", enumInfo.Name);  
            If enumInfo.Name = EnumType.SMOEnum Then  
                ' Set the ForEachEnumeratorInfo variable  
                ' to the SMO enumerator, and use it   
                ' later in the CreateNew method.  
                info = enumInfo  
            End If  
        Next enumInfo  
        Dim enumH As ForEachEnumeratorHost = info.CreateNew()  
        Console.WriteLine()  
        ' Show the description before it is modified.  
        Console.WriteLine("DelayValidation:  {0}", enumH.DelayValidation)  

        ' Modify the Description using SetExpression.  
        'String myExpression = "\"My Description for SMO enumerator\"";  
        Dim myExpression As String = "true"  
        enumH.SetExpression("DelayValidation", myExpression)  

        Dim result As DTSExecResult = pkg.Validate(Nothing, Nothing, Nothing, Nothing)  

        ' Review the new value and expression.  
        Dim newExpr As String = enumH.GetExpression("DelayValidation")  
        Console.WriteLine("New DelayValidation: {0}", enumH.DelayValidation)  
        Console.WriteLine("Expression:      {0}", newExpr)  

    End Sub 'Main  
End Class 'SSISProgram

Sample Output:

DelayValidation: False

New DelayValidation: False

Expression: true

Applies to

Share via