Server.UserDefinedMessages Property
Represents a collection of UserDefinedMessage objects. Each UserDefinedMessage object represents a user-defined message defined on the instance of Microsoft SQL Server.
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)
Syntax
'Declaration
Public ReadOnly Property UserDefinedMessages As UserDefinedMessageCollection
public UserDefinedMessageCollection UserDefinedMessages { get; }
public:
property UserDefinedMessageCollection^ UserDefinedMessages {
UserDefinedMessageCollection^ get ();
}
/** @property */
public UserDefinedMessageCollection get_UserDefinedMessages ()
public function get UserDefinedMessages () : UserDefinedMessageCollection
Property Value
A UserDefinedMessageCollection object that represents all the user-defined messages defined on the instance of SQL Server.
Remarks
Updated text:
The UserDefinedMessages property points to the UserDefinedMessageCollection object, which references the user-defined messages on the instance of SQL Server. You can use the collection to reference the user-defined messages. You can also add new user-defined messages by using the UserDefinedMessage constructor.
This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.
Example
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Display the user-defined message.
Dim sr As UserDefinedMessage
For Each sr In srv.UserDefinedMessages
Console.WriteLine(sr.Name)
Next
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Development Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
Target Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
See Also
Reference
Server Class
Server Members
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
How to: Add a New User-Defined Message in Visual Basic .NET
How to: Reference an Object by Using a Collection in Visual Basic .NET
Using Collections
Setting Properties
Managing Servers
Change History
Release |
History |
New content:
|