Share via


ForEachEnumeratorHostClass Class

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Defines the host class for the ForEachItemEnumeratorClass. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.Wrapper.ForEachEnumeratorHostClass

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

Syntax

'Declaration
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
<GuidAttribute("3442EA23-18C4-4A00-8ABD-C4157880CAA7")> _
Public Class ForEachEnumeratorHostClass _
    Implements ForEachEnumeratorHost, IDTSName100, IDTSObjectHost100, IDTSForEachEnumerator100,  _
    IDTSPropertiesProvider100
'Usage
Dim instance As ForEachEnumeratorHostClass
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[GuidAttribute("3442EA23-18C4-4A00-8ABD-C4157880CAA7")]
public class ForEachEnumeratorHostClass : ForEachEnumeratorHost, 
    IDTSName100, IDTSObjectHost100, IDTSForEachEnumerator100, IDTSPropertiesProvider100
[ClassInterfaceAttribute(ClassInterfaceType::None)]
[GuidAttribute(L"3442EA23-18C4-4A00-8ABD-C4157880CAA7")]
public ref class ForEachEnumeratorHostClass : ForEachEnumeratorHost, 
    IDTSName100, IDTSObjectHost100, IDTSForEachEnumerator100, IDTSPropertiesProvider100
[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
[<GuidAttribute("3442EA23-18C4-4A00-8ABD-C4157880CAA7")>]
type ForEachEnumeratorHostClass =  
    class 
        interface ForEachEnumeratorHost 
        interface IDTSName100 
        interface IDTSObjectHost100 
        interface IDTSForEachEnumerator100 
        interface IDTSPropertiesProvider100 
    end
public class ForEachEnumeratorHostClass implements ForEachEnumeratorHost, IDTSName100, IDTSObjectHost100, IDTSForEachEnumerator100, IDTSPropertiesProvider100

The ForEachEnumeratorHostClass type exposes the following members.

Constructors

  Name Description
Public method ForEachEnumeratorHostClass Infrastructure. Initializes a new instance of the ForEachEnumeratorHostClass class.

Top

Properties

  Name Description
Public property CollectionEnumerator Infrastructure. Gets or sets a Boolean that indicates if the hosting enumerator is enumerating collections of objects or enumerating collections of collections.
Public property CreationName Infrastructure. Returns the string that is used by the run-time to create an instance of the ForEachItemEnumeratorClass object. This property is read-only.
Public property DelayValidation Infrastructure. Gets or sets a Boolean that indicates whether ForEachItemEnumeratorClass validation is delayed until the package runs.
Public property Description Infrastructure. Gets or sets description for the host.
Public property HostType Infrastructure. Gets an enumeration that describes the type of host that the ForEachItemEnumeratorClass is being used by. This property is read-only.
Public property ID Infrastructure. Returns the GUID assigned to the host.
Public property InnerObject Infrastructure. Returns the inner object of the host, which is the ForEachItemEnumeratorClass that is being hosted.
Public property Name Infrastructure. Gets or sets a name for the host.
Public property Properties Infrastructure. Returns a IDTSProperties100 collection that contains IDTSProperty100 objects. Each IDTSProperty100 has additional information about each task in the ForEachItemEnumeratorClass.

Top

Methods

  Name Description
Public method ComputeExpressions Infrastructure. Computes the expressions in the property collection.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator Infrastructure. Returns an IEnumerator interface for use in iterating over the ForEachItemEnumeratorClass.
Public method GetExpression Infrastructure. Returns a String that contains the expression for the specified property. Null means no expression is assigned.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method InitializeForEachEnumerator Infrastructure. Initializes the properties associated with the task.
Protected method MemberwiseClone (Inherited from Object.)
Public method SetExpression Infrastructure. Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property.
Public method ToString (Inherited from Object.)
Public method Validate Infrastructure. Allows the host to determine if there are invalid settings that will prevent the ForEachItemEnumeratorClass from executing successfully.

Top

Remarks

For more information, see ForEachEnumeratorHost.

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace