SymmetricKeyCollection Class

The SymmetricKeyCollection class represents a collection of SymmetricKey objects that represent all the symmetric keys on the referenced database.

Inheritance Hierarchy


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


Public NotInheritable Class SymmetricKeyCollection _
    Inherits SimpleObjectCollectionBase
Dim instance As SymmetricKeyCollection
public sealed class SymmetricKeyCollection : SimpleObjectCollectionBase
public ref class SymmetricKeyCollection sealed : public SimpleObjectCollectionBase
type SymmetricKeyCollection =  
        inherit SimpleObjectCollectionBase 
public final class SymmetricKeyCollection extends SimpleObjectCollectionBase

The SymmetricKeyCollection type exposes the following members.


  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 SymmetricKey object in the collection by index number.
Public property Item[String] Gets a SymmetricKey object in the collection by name.
Public property Parent Gets the Database object that is the parent of the SymmetricKeyCollection object.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)



  Name Description
Public method Add Adds a symmetric key to the database.
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Public method Contains Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
Public method CopyTo Copies the collection of objects to a one-dimensional array starting at the specified index value.
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 SymmetricKeyCollection collection by 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 ToString (Inherited from Object.)



  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.)


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.)



An SymmetricKeyCollection object can be used to gain access to a set of symmetric keys. You can use the Item property to return a specific SymmetricKey object.


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


Microsoft.SqlServer.Management.Smo Namespace