Export (0) Print
Expand All

UserDefinedMessageCollection Class

 

Applies To: SQL Server 2016 Preview

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

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


<DefaultMemberAttribute("Item")>
Public NotInheritable Class UserDefinedMessageCollection
	Inherits MessageCollectionBase

NameDescription
System_CAPS_pubpropertyCount

Gets the number of objects in the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubpropertyIsSynchronized

Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe.(Inherited from SmoCollectionBase.)

System_CAPS_pubpropertyItem(Int32)

Gets a UserDefinedMessage object in the collection by index number.

System_CAPS_pubpropertyItem(Int32, String)

Gets a UserDefinedMessage object in the collection by message ID value and language.

System_CAPS_pubpropertyParent

Gets the Server object that is the parent of the UserDefinedMessage object.

System_CAPS_pubpropertySyncRoot

Gets an object that can be used to synchronize access to the collection.(Inherited from SmoCollectionBase.)

NameDescription
System_CAPS_protmethodAddExisting(SqlSmoObject)

Adds an object to the collection.(Inherited from AbstractCollectionBase.)

System_CAPS_pubmethodContains(Int32, Int32)

Determines whether an object with the specified ID value and language ID value exists in the message collection object.(Inherited from MessageCollectionBase.)

System_CAPS_pubmethodContains(Int32, String)

Determines whether an object with the specified ID value and language exists in the message collection object.(Inherited from MessageCollectionBase.)

System_CAPS_pubmethodCopyTo(UserDefinedMessage(), Int32)

Copies the collection objects to a one-dimensional array beginning at the index value specified.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodItemByIdAndLanguage(Int32, String)

Extracts a member from the UserDefinedMessageCollection collection using a system-defined, unique identifier and the specified language.

System_CAPS_pubmethodItemByIdAndLanguageId(Int32, Int32)

Extracts a member from the UserDefinedMessageCollection collection using a system-defined, unique identifier and the specified language.

System_CAPS_pubmethodRefresh()

Refreshes the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubmethodRefresh(Boolean)

Refreshes the referenced collection with the option to refresh child objects of the referenced collection.(Inherited from SmoCollectionBase.)

System_CAPS_pubmethodRemove(Int32)

Removes the object with the specified ID value from the message collection object.(Inherited from MessageCollectionBase.)

System_CAPS_pubmethodRemove(Int32, String)

Removes the object with the specified ID value and language from the message collection object.(Inherited from MessageCollectionBase.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_protfieldinitialized

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

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

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

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.

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.

Legacy Code Example

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

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft