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)

public UserDefinedMessageCollection UserDefinedMessages { 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.

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.

'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

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.

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms



New content:
  • Added code sample to the Example section.

  • Added to the description in the Remarks section.

Community Additions