ForEachEnumeratorHostClass Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime.Wrapper

Assembly:

Microsoft.SqlServer.DTSRuntimeWrap.dll

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

public ref class ForEachEnumeratorHostClass : Microsoft::SqlServer::Dts::Runtime::Wrapper::ForEachEnumeratorHost, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSForEachEnumerator100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSObjectHost100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSPropertiesProvider100

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)]
[System.Runtime.InteropServices.Guid("DF8B04F8-DC40-4E1D-AA34-2535D6C0D691")]
public class ForEachEnumeratorHostClass : Microsoft.SqlServer.Dts.Runtime.Wrapper.ForEachEnumeratorHost, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSForEachEnumerator100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSObjectHost100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPropertiesProvider100

[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)>]
[<System.Runtime.InteropServices.Guid("DF8B04F8-DC40-4E1D-AA34-2535D6C0D691")>]
type ForEachEnumeratorHostClass = class
    interface ForEachEnumeratorHost
    interface IDTSName100
    interface IDTSObjectHost100
    interface IDTSForEachEnumerator100
    interface IDTSPropertiesProvider100

Public Class ForEachEnumeratorHostClass
Implements ForEachEnumeratorHost, IDTSForEachEnumerator100, IDTSObjectHost100, IDTSPropertiesProvider100

Inheritance

Object

ForEachEnumeratorHostClass

Attributes

ClassInterfaceAttribute GuidAttribute TypeLibTypeAttribute

Implements

ForEachEnumeratorHost IDTSForEachEnumerator100 IDTSName100 IDTSObjectHost100 IDTSPropertiesProvider100

Remarks

For more information, see ForEachEnumeratorHost.

Constructors

ForEachEnumeratorHostClass()

Initializes a new instance of the ForEachEnumeratorHostClass class.

Properties

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

Methods

ComputeExpressions(Boolean)	Computes the expressions in the property collection.
GetEnumerator(IDTSConnections100, IDTSVariableDispenser100, IDTSInfoEvents100, IDTSLogging100)	Returns an IEnumerator interface for use in iterating over the ForEachItemEnumeratorClass.
GetExpression(String)	Returns a String that contains the expression for the specified property. Null means no expression is assigned.
InitializeForEachEnumerator(IDTSConnections100, IDTSInfoEvents100, IDTSObjectReferenceTracker100)	Initializes the properties associated with the task.
SetExpression(String, String)	Assigns the specified expression to the property. Specify null to remove an existing expression from the property.
Validate(IDTSConnections100, IDTSVariableDispenser100, IDTSInfoEvents100, IDTSLogging100)	Allows the host to determine if there are invalid settings that will prevent the ForEachItemEnumeratorClass from executing successfully.