Share via


Parameters Class

Represents a class used by both the package parameters and project parameters collection.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DTSReadOnlyCollectionBase
    Microsoft.SqlServer.Dts.Runtime.Parameters

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

Syntax

'Declaration
Public MustInherit Class Parameters _
    Inherits DTSReadOnlyCollectionBase
'Usage
Dim instance As Parameters
public abstract class Parameters : DTSReadOnlyCollectionBase
public ref class Parameters abstract : public DTSReadOnlyCollectionBase
[<AbstractClassAttribute>]
type Parameters =  
    class 
        inherit DTSReadOnlyCollectionBase 
    end
public abstract class Parameters extends DTSReadOnlyCollectionBase

The Parameters type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of elements contained in the DTSReadOnlyCollectionBase instance. (Inherited from DTSReadOnlyCollectionBase.)
Public property IsSynchronized Gets a value that indicates whether access to the DTSReadOnlyCollectionBase is synchronized (thread-safe). (Inherited from DTSReadOnlyCollectionBase.)
Public property Item[Int32] Returns a parameter object in the parameters collection with the specified index.
Public property Item[String] Returns a parameter object in the parameters collection with the specified name.
Public property SyncRoot Gets an object that can be used to synchronize access to the DTSReadOnlyCollectionBase. (Inherited from DTSReadOnlyCollectionBase.)

Top

Methods

  Name Description
Public method Add Adds a parameter object to the parameters collection with the specified name and data type.
Public method Contains Determines whether a parameter object with the specified name is contained in the parameters collection.
Public method CopyTo Copies the entire DTSReadOnlyCollectionBase to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from DTSReadOnlyCollectionBase.)
Protected method CreateManagedObject Infrastructure. Creates managed object from an unmanaged object. (Inherited from DTSReadOnlyCollectionBase.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetCount Infrastructure. Retrieves the number of objects in the collection. (Inherited from DTSReadOnlyCollectionBase.)
Public method GetEnumerator Returns an enumerator that can iterate through the DTSReadOnlyCollectionBase instance. (Inherited from DTSReadOnlyCollectionBase.)
Public method GetHashCode (Inherited from Object.)
Protected method GetManagedEnumerator Infrastructure. Gets the managed enumerator from an unmanaged enumerator. (Inherited from DTSReadOnlyCollectionBase.)
Public method GetType (Inherited from Object.)
Public method Insert Inserts a parameter object to the parameters collection with the specified index, name, and data type. Only project parameters can be inserted to the parameters collection.
Public method Join Joins the specified parameter to the parameters collection.
Protected method MemberwiseClone (Inherited from Object.)
Public method Remove Removes a parameter object from the parameters collection.
Public method RemoveAt Removes a parameter object from the parameters collection with the specified index. Only project parameters can be removed from the parameters collection.
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Protected field m_unmanagedColl Infrastructure. The unmanaged collection. (Inherited from DTSReadOnlyCollectionBase.)

Top

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 Namespace