Package.GetExpression Method (String)

Article
07/16/2015

Applies To: SQL Server 2016 Preview

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

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

Syntax

public string GetExpression(
    string propertyName
)

public:
virtual String^ GetExpression(
    String^ propertyName
) sealed

abstract GetExpression : 
        propertyName:string -> string
override GetExpression : 
        propertyName:string -> string

Public Function GetExpression (
    propertyName As String
) As String

Parameters

propertyName
Type: System.String

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

Return Value

Type: System.String

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

Implements

IDTSPropertiesProvider.GetExpression(String)

Remarks

The propertyName can be any property available on the object.

Examples

Legacy Code Example

The following code example modifies the value of the DelayValidation property using SetExpression, then displays the new value using GetExpression.

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();
            // Set an expression on one of the properties.
            DtsProperties pkgProperties = pkg.Properties;

            // View information about the DelayValidation property 
            // before setting it with the SetExpression method.
            Object myValue = pkgProperties["DelayValidation"].GetValue(pkg);
            String mySValue = myValue.ToString();
            Console.WriteLine("value before is {0}", mySValue); 
            
            // Use SetExpression to set the value to true.
            String myTrueString = "true";
            pkgProperties["DelayValidation"].SetExpression(pkg, myTrueString);

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

            // Verify the new setting.
            myValue = pkgProperties["DelayValidation"].GetValue(pkg);
            mySValue = myValue.ToString();

            String myExpression = pkg.Properties["DelayValidation"].GetExpression(pkg);
            String mySExpression = myExpression.ToString();
            Console.WriteLine("The value and expression is {0}, {1}", mySValue, mySExpression);
        }
    }
}

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

Class Program
    Shared Sub Main(ByVal args() As String) 
        Dim pkg As New Package()
        ' Set an expression on one of the properties.
        Dim pkgProperties As DtsProperties = pkg.Properties
        
        ' View information about the DelayValidation property 
        ' before setting it with the SetExpression method.
        Dim myValue As [Object] = pkgProperties("DelayValidation").GetValue(pkg)
        Dim mySValue As String = myValue.ToString()
        Console.WriteLine("value before is {0}", mySValue)
        
        ' Use SetExpression to set the value to true.
        Dim myTrueString As String = "true"
        pkgProperties("DelayValidation").SetExpression(pkg, myTrueString)
        
        ' Validate the package to set the expression onto the property.
        Dim valResult As DTSExecResult = pkg.Validate(Nothing, Nothing, Nothing, Nothing)
        
        ' Verify the new setting.
        myValue = pkgProperties("DelayValidation").GetValue(pkg)
        mySValue = myValue.ToString()
        
        Dim myExpression As String = pkg.Properties("DelayValidation").GetExpression(pkg)
        Dim mySExpression As String = myExpression.ToString()
        Console.WriteLine("The value and expression is {0}, {1}", mySValue, mySExpression)
    End Sub
End Class

Sample Output:

value before is False

The value and expression is True, true