ForEachVariableMapping.Description Property

Gets or sets a String that contains the description for the variable.

네임스페이스: Microsoft.SqlServer.Dts.Runtime
어셈블리: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

구문

‘선언
Public Property Description As String

public string Description { get; set; }

public:
virtual property String^ Description {
    String^ get () sealed;
    void set (String^ value) sealed;
}

/** @property */
public final String get_Description ()

/** @property */
public final void set_Description (String value)

public final function get Description () : String

public final function set Description (value : String)

속성 값

A String that contains information about the variable.

예

The following code example creates a ForEachVariableMapping, sets the read-write properties, views the read-only properties, and sets up a mapping using the VariableName and ValueIndex properties.

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

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        public static void Main()
        {
            // Create the new application and package.
            Application app = new Application();
            Package package = new Package();

            // Create ForEachLoop task
            Executables executables = package.Executables;
            ForEachLoop forEachLoop = executables.Add("STOCK:FOREACHLOOP") as ForEachLoop;
  
            // Create a VariableMappings and VariableMapping objects.
            ForEachVariableMappings forEachVariableMappings = forEachLoop.VariableMappings;
            ForEachVariableMapping forEachVariableMapping = forEachVariableMappings.Add();
            // Set the properties.
            forEachVariableMapping.Description = "My ForEach Variable Mapping";
            forEachVariableMapping.Name = "My Name is ForEachVariableMapping";
            
            // View the read-only properties. CreationName can be blank.
            Console.WriteLine("ID:           {0}", forEachVariableMapping.ID);
            Console.WriteLine("CreationName: {0}", forEachVariableMapping.CreationName);

            // Create a mapping between the variable and its value.
            forEachVariableMapping.VariableName = @"Id";
            forEachVariableMapping.ValueIndex = 0;

            // Add other tasks to ForEachLoop container.
            //...

            // Run the package when the rest of the code is finished. 
            DTSExecResult status = package.Execute();
        }
    }
}

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

Namespace Microsoft.SqlServer.SSIS.Samples
   
   Class Program
      
      Public Shared Sub Main()
         ' Create the new application and package.
         Dim app As New Application()
         Dim package As New Package()
         
         ' Create ForEachLoop task
         Dim executables As Executables = package.Executables
         Dim forEachLoop As ForEachLoop = CType(executables.Add("STOCK:FOREACHLOOP"), ForEachLoop)
         
         ' Create a VariableMappings and VariableMapping objects.
         Dim forEachVariableMappings As ForEachVariableMappings = forEachLoop.VariableMappings
         Dim forEachVariableMapping As ForEachVariableMapping = forEachVariableMappings.Add()
         ' Set the properties.
         forEachVariableMapping.Description = "My ForEach Variable Mapping"
         forEachVariableMapping.Name = "My Name is ForEachVariableMapping"
         
         ' View the read-only properties. CreationName can be blank.
         Console.WriteLine("ID:           {0}", forEachVariableMapping.ID)
         Console.WriteLine("CreationName: {0}", forEachVariableMapping.CreationName)
         
         ' Create a mapping between the variable and its value.
         forEachVariableMapping.VariableName = "Id"
         forEachVariableMapping.ValueIndex = 0
         
         Console.WriteLine()
         
         ' Add other tasks to ForEachLoop container.
         '...
         ' Run the package when the rest of the code is finished. 
         Dim status As DTSExecResult = package.Execute()
      End Sub 'Main
   End Class 'Program
End Namespace 'Microsoft.SqlServer.SSIS.Samples

Sample Output:

ID: {DDCF34B7-853F-4013-B924-93D1A00DEC3F}

CreationName:

스레드 보안

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.

플랫폼

개발 플랫폼

지원되는 플랫폼 목록은 SQL Server 2005 설치를 위한 하드웨어 및 소프트웨어 요구 사항을 참조하십시오.

대상 플랫폼

지원되는 플랫폼 목록은 SQL Server 2005 설치를 위한 하드웨어 및 소프트웨어 요구 사항을 참조하십시오.

참고 항목

참조

ForEachVariableMapping Class
ForEachVariableMapping Members
Microsoft.SqlServer.Dts.Runtime Namespace