Sequence.SetExpression Method

Artykuł
12/03/2008

Assigns the specified expression to the property. Specify null 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 _
)

public void SetExpression (
    string propertyName,
    string expression
)

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

public final void SetExpression (
    String propertyName, 
    String expression
)

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

Parameters

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

expression
The expression.

Remarks

The propertyName can be any property available on the object.

Example

The following code example uses SetExpression to modify the value of the Description on a Sequence container. Then GetExpression is used to retrieve the expression.

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

namespace Microsoft.SqlServer.SSIS.Sample
{
    class Program
    {
        static void Main(string[] args)
        {
            const String containerName = "Sequence";
            Package pkg = new Package();
            Sequence sequence = (Sequence)pkg.Executables.Add("STOCK:Sequence");
            DtsProperties seqProps = sequence.Properties;

            // View information about the Description property
            // before setting it using the SetExpression method.
            String desc = sequence.Description;
            Console.WriteLine("Original value of Description: {0}", desc);

            // Use SetExpression to give the Sequence a description.
            String myExpression = "\"Testing " + containerName + "\""; 
            sequence.SetExpression("Description", myExpression);
            // Note that I've tried using the Properties bag instead, with no change to the results.
            //seqProps["Description"].SetExpression(sequence, 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 myNewDesc = sequence.Description;
            String myNewExpression = sequence.GetExpression("Description");
            Console.WriteLine("New value of Description: {0}", myNewDesc);
            Console.WriteLine("Expression for Description: {0}", myNewExpression);
        }
    }
}

Sample Output:

Original value of Description:

New value of Description: Testing Sequence

Expression for Description: "Testing Sequence"

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms