MessageCollectionBase Class

  • Article

The MessageCollectionBase class is a base class that is used in the construction of message collection classes.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
        Microsoft.SqlServer.Management.Smo.MessageCollectionBase
          Microsoft.SqlServer.Management.Smo.SystemMessageCollection
          Microsoft.SqlServer.Management.Smo.UserDefinedMessageCollection

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

Syntax

'Declaration
Public Class MessageCollectionBase _
    Inherits SortedListCollectionBase
'Usage
Dim instance As MessageCollectionBase

public class MessageCollectionBase : SortedListCollectionBase

public ref class MessageCollectionBase : public SortedListCollectionBase

type MessageCollectionBase =  
    class 
        inherit SortedListCollectionBase 
    end

public class MessageCollectionBase extends SortedListCollectionBase

The MessageCollectionBase 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 SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Methods

  Name Description
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Protected method AddImpl Adds the specified object to this collection (Inherited from SortedListCollectionBase.)
Public method Contains(Int32, Int32) Determines whether an object with the specified ID value and language ID value exists in the message collection object.
Public method Contains(Int32, String) Determines whether an object with the specified ID value and language exists in the message collection object.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetCollectionElementType Gets the Collection Element Type. (Inherited from SmoCollectionBase.)
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.)
Protected method GetItemById(Int32) Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
Protected method GetItemById(Int32, String) Extracts a member from the referenced collection using a system-defined, unique identifier and name. (Inherited from SmoCollectionBase.)
Protected method GetObjectByIndex Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
Public method GetType (Inherited from Object.)
Protected method ImplAddExisting Adds an existing specified object to this collection (Inherited from SortedListCollectionBase.)
Protected method InitializeChildCollection() Initializes the child collections of the referenced collection. (Inherited from SmoCollectionBase.)
Protected method InitializeChildCollection(Boolean) Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection. (Inherited from SmoCollectionBase.)
Protected method InitInnerCollection This method supports the SMO infrastructure and is not intended to be used directly from your code. (Overrides SmoCollectionBase.InitInnerCollection().)
Protected method MemberwiseClone (Inherited from Object.)
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(Int32) Removes the object with the specified ID value from the message collection object.
Public method Remove(Int32, String) Removes the object with the specified ID value and language from the message collection object.
Public method ToString (Inherited from Object.)
Protected method ValidateParentObject Validates the parent object exists. (Inherited from SmoCollectionBase.)

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

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