Share via


StoredProcedureParameterCollection Class

The StoredProcedureParameterCollection class represents a collection of StoredProcedureParameter objects that represent all the stored procedure parameters defined on a table.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.ArrayListCollectionBase
        Microsoft.SqlServer.Management.Smo.ParameterCollectionBase
          Microsoft.SqlServer.Management.Smo.StoredProcedureParameterCollection

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class StoredProcedureParameterCollection _
    Inherits ParameterCollectionBase
'Usage
Dim instance As StoredProcedureParameterCollection
public sealed class StoredProcedureParameterCollection : ParameterCollectionBase
public ref class StoredProcedureParameterCollection sealed : public ParameterCollectionBase
[<SealedAttribute>]
type StoredProcedureParameterCollection =  
    class 
        inherit ParameterCollectionBase 
    end
public final class StoredProcedureParameterCollection extends ParameterCollectionBase

The StoredProcedureParameterCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public property IsSynchronized Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public property Item[Int32] Gets a StoredProcedureParameter object in the collection by index number.
Public property Item[String] Gets a StoredProcedureParameter object in the collection by name.
Public property Parent Gets the StoredProcedure object that is the parent of the StoredProcedureParameter object.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Methods

  Name Description
Public method Add(StoredProcedureParameter) Adds a StoredProcedureParameter object to the StoredProcedureParameterCollection object.
Public method Add(StoredProcedureParameter, Int32) Adds a StoredProcedureParameter object to the StoredProcedureParameterCollection object.
Public method Add(StoredProcedureParameter, String) Adds a StoredProcedureParameter object to the StoredProcedureParameterCollection object.
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Public method Contains Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from ParameterCollectionBase.)
Public method CopyTo Copies the collection objects to a one-dimensional array starting at the index value specified.
Public method Equals (Inherited from Object.)
Public method GetEnumerator Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ItemById Extracts a member from the StoredProcedureParameterCollection object using a system-defined, unique identifier.
Public method Refresh() Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public method Refresh(Boolean) Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public method Remove(String) Removes a member from the collection with the specified name. (Inherited from ParameterCollectionBase.)
Public method Remove(StoredProcedureParameter) Removes a StoredProcedureParameter object from the StoredProcedureParameterCollection object.
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Protected field initialized This value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top

Remarks

A StoredProcedureParameterCollection object can be used to gain access to a set of stored procedure parameters. You can use the Item property to return a specific StoredProcedureParameter object.

Thread Safety

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

Examples

Using Collections

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.Management.Smo Namespace