SymmetricKeyCollection Class

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

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
        Microsoft.SqlServer.Management.Smo.SimpleObjectCollectionBase
          Microsoft.SqlServer.Management.Smo.SymmetricKeyCollection

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

Syntax

'Declaration
Public NotInheritable Class SymmetricKeyCollection _
    Inherits SimpleObjectCollectionBase
'Usage
Dim instance As SymmetricKeyCollection

public sealed class SymmetricKeyCollection : SimpleObjectCollectionBase

public ref class SymmetricKeyCollection sealed : public SimpleObjectCollectionBase

[<SealedAttribute>]
type SymmetricKeyCollection =  
    class 
        inherit SimpleObjectCollectionBase 
    end

public final class SymmetricKeyCollection extends SimpleObjectCollectionBase

The SymmetricKeyCollection type exposes the following members.

Properties

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

Top

Methods

	Name	Description
	Add	Adds a symmetric key to the database.
	AddExisting	Adds an object to the collection. (Inherited from AbstractCollectionBase.)
	Contains	Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
	CopyTo	Copies the collection of objects to a one-dimensional array starting at the specified index value.
	Equals	(Inherited from Object.)
	GetEnumerator	Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ItemById	Extracts a member from the SymmetricKeyCollection collection by using a system-defined, unique identifier.
	Refresh()	Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
	Refresh(Boolean)	Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
	ToString	(Inherited from Object.)

Top

Fields

	Name	Description
	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
	ICollection.CopyTo	Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top

Remarks

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.

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.

Share via