SystemMessageCollection Class
The SystemMessageCollection class represents a collection of SystemMessage objects that represent all the system messages on the instance of SQL Server.
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
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public Class SystemMessageCollection _
Inherits MessageCollectionBase
'Usage
Dim instance As SystemMessageCollection
public class SystemMessageCollection : MessageCollectionBase
public ref class SystemMessageCollection : public MessageCollectionBase
type SystemMessageCollection =
class
inherit MessageCollectionBase
end
public class SystemMessageCollection extends MessageCollectionBase
The SystemMessageCollection 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 SystemMessage object in the collection by index number. |
![]() |
Item[Int32, String] | Gets a SystemMessage object in the collection by name. |
![]() |
Parent | Gets the Server object that is the parent of the SystemMessageCollection object. |
![]() |
SyncRoot | Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.) |
Top
Methods
Name | Description | |
---|---|---|
![]() |
AddExisting | Adds an object to the collection. (Inherited from AbstractCollectionBase.) |
![]() |
AddImpl | Adds the specified object to this collection (Inherited from SortedListCollectionBase.) |
![]() |
Contains(Int32, Int32) | Determines whether an object with the specified ID value and language ID value exists in the message collection object. (Inherited from MessageCollectionBase.) |
![]() |
Contains(Int32, String) | Determines whether an object with the specified ID value and language exists in the message collection object. (Inherited from MessageCollectionBase.) |
![]() |
CopyTo | Copies the collection of objects to a one-dimensional array beginning at the index value specified. |
![]() |
Equals | (Inherited from Object.) |
![]() |
Finalize | (Inherited from Object.) |
![]() |
GetCollectionElementType | Returns the Collection Element type. (Overrides SmoCollectionBase.GetCollectionElementType().) |
![]() |
GetEnumerator | Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.) |
![]() |
GetHashCode | (Inherited from Object.) |
![]() |
GetItemById(Int32) | Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.) |
![]() |
GetItemById(Int32, String) | Extracts a member from the referenced collection using a system-defined, unique identifier and name. (Inherited from SmoCollectionBase.) |
![]() |
GetObjectByIndex | Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.) |
![]() |
GetType | (Inherited from Object.) |
![]() |
ImplAddExisting | Adds an existing specified object to this collection (Inherited from SortedListCollectionBase.) |
![]() |
InitializeChildCollection() | Initializes the child collections of the referenced collection. (Inherited from SmoCollectionBase.) |
![]() |
InitializeChildCollection(Boolean) | Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection. (Inherited from SmoCollectionBase.) |
![]() |
InitInnerCollection | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from MessageCollectionBase.) |
![]() |
ItemByIdAndLanguage | Extracts a member from the SystemMessageCollection collection using a system-defined, unique identifier and the specified language. |
![]() |
ItemByIdAndLanguageId | Extracts a member from the SystemMessageCollection collection using a system-defined, unique identifier and the specified language ID. |
![]() |
MemberwiseClone | (Inherited from Object.) |
![]() |
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.) |
![]() |
Remove(Int32) | Removes the object with the specified ID value from the message collection object. (Inherited from MessageCollectionBase.) |
![]() |
Remove(Int32, String) | Removes the object with the specified ID value and language from the message collection object. (Inherited from MessageCollectionBase.) |
![]() |
ToString | (Inherited from Object.) |
![]() |
ValidateParentObject | Validates the parent object exists. (Inherited from SmoCollectionBase.) |
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
A SystemMessageCollection object can be used to gain access to a set of system messages. You can use the Item property to return a specific SystemMessage object.
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.