Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SynonymCollection Class

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

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
[<SealedAttribute>]
type SynonymCollection =  
    class 
        inherit SchemaCollectionBase 
    end

The SynonymCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public propertyIsSynchronizedGets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public propertyItem(Int32)Gets a Synonym object in the collection by index number.
Public propertyItem(String)Gets a Synonym object in the collection by name.
Public propertyItem(String, String)Gets a Synonym object in the collection by name.
Public propertyParentGets the Database object that is the parent of the SynonymCollection object.
Public propertySyncRootGets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)
Top
  NameDescription
Public methodAddAdd a synonym to the collection.
Protected methodAddExistingAdds an object to the collection. (Inherited from AbstractCollectionBase.)
Public methodContains(String)Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from SchemaCollectionBase.)
Public methodContains(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.)
Public methodCopyToCopies the collection of objects to a one-dimensional array starting at the specified index value.
Public methodEquals (Inherited from Object.)
Public methodGetEnumeratorReturns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodItemByIdExtracts a member from the SynonymCollection collection by using a system-defined, unique identifier.
Public methodRefresh()Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public methodRefresh(Boolean)Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public methodToString (Inherited from Object.)
Top
  NameDescription
Protected fieldinitializedThis value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.)
Top
  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies 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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.