UserDefinedMessageCollection Class

The UserDefinedMessageCollection class represents a collection of UserDefinedMessage objects that represent all the user-defined messages defined on a table.

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.UserDefinedMessageCollection

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

Syntax

'Declaration
Public NotInheritable Class UserDefinedMessageCollection _
    Inherits MessageCollectionBase
'Usage
Dim instance As UserDefinedMessageCollection

public sealed class UserDefinedMessageCollection : MessageCollectionBase

public ref class UserDefinedMessageCollection sealed : public MessageCollectionBase

[<SealedAttribute>]
type UserDefinedMessageCollection =  
    class
        inherit MessageCollectionBase
    end

public final class UserDefinedMessageCollection extends MessageCollectionBase

The UserDefinedMessageCollection 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 UserDefinedMessage object in the collection by index number.
	Item[Int32, String]	Gets a UserDefinedMessage object in the collection by message ID value and language.
	Parent	Gets the Server object that is the parent of the UserDefinedMessage 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 objects to a one-dimensional array beginning at the index value specified.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetCollectionElementType	Gets the Collection Element Type. (Inherited from SmoCollectionBase.)
	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 UserDefinedMessageCollection collection using a system-defined, unique identifier and the specified language.
	ItemByIdAndLanguageId	Extracts a member from the UserDefinedMessageCollection collection using a system-defined, unique identifier and the specified language.
	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 UserDefinedMessageCollection object can be used to gain access to a set of user-defined messages. You can use the Item property to return a specific UserDefinedMessage object.

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