SynonymCollection Class

The SynonymCollection class represents a collection of Synonym objects that represent all the synonyms on the referenced database.

Inheritance Hierarchy

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

'Declaration
Public NotInheritable Class SynonymCollection _
    Inherits SchemaCollectionBase
'Usage
Dim instance As SynonymCollection

public sealed class SynonymCollection : SchemaCollectionBase

public ref class SynonymCollection sealed : public SchemaCollectionBase

[<SealedAttribute>]
type SynonymCollection =  
    class 
        inherit SchemaCollectionBase 
    end

public final class SynonymCollection extends SchemaCollectionBase

The SynonymCollection type exposes the following members.

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

Top

	Name	Description
	Add	Add a synonym to the collection.
	AddExisting	Adds an object to the collection. (Inherited from AbstractCollectionBase.)
	Contains(String)	Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from SchemaCollectionBase.)
	Contains(String, String)	Validates whether the parameter collection contains a member with a name equal to the specified string and with the specified schema. (Inherited from SchemaCollectionBase.)
	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 SynonymCollection 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

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

Top

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

Top

A SynonymCollection object can be used to gain access to a set of synonyms. You can use the Item property to return a specific Synonym object.

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