ForEachEnumeratorHost.Properties Property
Returns a DtsProperties collection that contains DtsProperty objects. Each DtsProperty has additional information about each task in the ForEachEnumeratorHost.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)
Syntax
'Declaration
Public ReadOnly Property Properties As DtsProperties
public DtsProperties Properties { get; }
public:
virtual property DtsProperties^ Properties {
DtsProperties^ get () sealed;
}
/** @property */
public final DtsProperties get_Properties ()
public final function get Properties () : DtsProperties
Property Value
A DtsProperties collection.
Example
The following code example hosts a ForEachSMOEnumerator in the ForEachEnumeratorHost, then displays the properties collection of the host.
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)
{
if (enumInfo.Name == EnumType.SMOEnum)
{
info = enumInfo;
}
}
ForEachEnumeratorHost enumH = info.CreateNew();
DtsProperties hostProps = enumH.Properties;
// Display the name and type of properties in the collection.
foreach (DtsProperty prop in hostProps)
{
Console.WriteLine("Property Name {0}, Type {1}", prop.Name, prop.Type);
//Console.WriteLine("Property Type {0}", prop.Type);
}
ForEachSMOEnumerator smoEnumerator = (ForEachSMOEnumerator)enumH.InnerObject;
}
}
}
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
Dim enumInfo As ForEachEnumeratorInfo
End Enum
For Each EnumInfo In infos
For Each EnumInfo In infos
For Each EnumInfo In infos If EnumInfo.Name = EnumType.SMOEnum Then info = EnumInfo End Enum End Enum
For Each enumInfo In infos
If enumInfo.Name = EnumType.SMOEnum Then
info = enumInfo
End Enum
End Enum
End Enum
End If
Next
Dim EnumH As ForEachEnumeratorHost = info.CreateNew()
Dim enumH As ForEachEnumeratorHost = info.CreateNew()
End Enum
Dim hostProps As DtsProperties = EnumH.Properties
Dim hostProps As DtsProperties = enumH.Properties
End Enum
' Display the name and type of properties in the collection.
Dim prop As DtsProperty
For Each prop In hostProps
Console.WriteLine("Property Name {0}, Type {1}", prop.Name, prop.Type)
'Console.WriteLine("Property Type {0}", prop.Type);
Next
Dim smoEnumerator As ForEachSMOEnumerator = CType(EnumH.InnerObject, ForEachSMOEnumerator)
Dim smoEnumerator As ForEachSMOEnumerator = CType(enumH.InnerObject, ForEachSMOEnumerator)
End Enum
End Sub
End Class
End Namespace
Sample Output:
Property Name CollectionEnumerator, Type Boolean
Property Name CreationName, Type String
Property Name Description, Type String
Property Name EnumURN, Type String
Property Name ID, Type String
Property Name Name, Type String
Property Name Version, Type Int32
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.
See Also
Reference
ForEachEnumeratorHost Class
ForEachEnumeratorHost Members
Microsoft.SqlServer.Dts.Runtime Namespace