ForEachEnumeratorHost.Description Property

Artykuł
12/03/2008

Gets or sets description for the host.

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

Syntax

'Declaration
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)

Property Value

A String that contains the description.

Example

The following code example creates a ForEachEnumeratorHost to hold a ForEachSMOEnumerator enumerator, and displays the host properties.

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

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

            foreach (ForEachEnumeratorInfo enumInfo in infos)
            {
                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();
            Console.WriteLine("Host InnerObject: " + enumH.InnerObject.ToString());
            Console.WriteLine("CollectionEnumerator? {0}", enumH.CollectionEnumerator);
            Console.WriteLine("CreationName: {0}",  enumH.CreationName);
            Console.WriteLine("Description:  {0}", enumH.Description);
            Console.WriteLine("Value of DelayValidation: {0}", enumH.DelayValidation);
            Console.WriteLine("HostType:    {0}", enumH.HostType);
            Console.WriteLine("ID:          {0}", enumH.ID);
            Console.WriteLine("Name:        {0}", enumH.Name);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Microsoft.SqlServer.SSIS.Sample
    Friend Class EnumType
        Public const String SMOEnum = "Foreach SMO Enumerator"
    End Class
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim infos As ForEachEnumeratorInfos =  app.ForEachEnumeratorInfos 
            Dim info As ForEachEnumeratorInfo =  Nothing 
 
            Dim enumInfo As ForEachEnumeratorInfo
            For Each enumInfo In infos
                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
            Dim enumH As ForEachEnumeratorHost =  info.CreateNew() 
            Console.WriteLine()
            Console.WriteLine("Host InnerObject: " + enumH.InnerObject.ToString())
            Console.WriteLine("CollectionEnumerator? {0}", enumH.CollectionEnumerator)
            Console.WriteLine("CreationName: {0}",  enumH.CreationName)
            Console.WriteLine("Description:  {0}", enumH.Description)
            Console.WriteLine("Value of DelayValidation: {0}", enumH.DelayValidation)
            Console.WriteLine("HostType:    {0}", enumH.HostType)
            Console.WriteLine("ID:          {0}", enumH.ID)
            Console.WriteLine("Name:        {0}", enumH.Name)
        End Sub
    End Class
End Namespace

Sample Output:

Available enumerators: Foreach File Enumerator

Available enumerators: Foreach Item Enumerator

Available enumerators: Foreach ADO Enumerator

Available enumerators: Foreach ADO.NET Schema Rowset Enumerator

Available enumerators: Foreach From Variable Enumerator

Available enumerators: Foreach NodeList Enumerator

Available enumerators: Foreach SMO Enumerator

Host InnerObject: Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO.ForEachSMOEnumerator

CollectionEnumerator? False

CreationName: Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO.ForEachSMOEnumerator, Microsoft.SqlServer.ForEachSMOEnumerator, Version=9.0.242.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

Description:

Value of DelayValidation: False

HostType: ForEachEnumerator

ID: {C91BA4D0-6AD4-4BEE-A7C4-9A737880773E}

Name: {C91BA4D0-6AD4-4BEE-A7C4-9A737880773E}

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

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

Udostępnij za pośrednictwem