• Article

Server.UserDefinedMessages Property

Represents a collection of UserDefinedMessage objects. Each UserDefinedMessage object represents a user-defined message defined on the instance of SQL Server.

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

Syntax

'Declaration
<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,  _
    GetType(UserDefinedMessage))> _
Public ReadOnly Property UserDefinedMessages As UserDefinedMessageCollection
    Get
'Usage
Dim instance As Server
Dim value As UserDefinedMessageCollection

value = instance.UserDefinedMessages

[SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(UserDefinedMessage))]
public UserDefinedMessageCollection UserDefinedMessages { get; }

[SfcObjectAttribute(SfcContainerRelationship::ObjectContainer, SfcContainerCardinality::ZeroToAny, 
    typeof(UserDefinedMessage))]
public:
property UserDefinedMessageCollection^ UserDefinedMessages {
    UserDefinedMessageCollection^ get ();
}

[<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(UserDefinedMessage))>]
member UserDefinedMessages : UserDefinedMessageCollection

function get UserDefinedMessages () : UserDefinedMessageCollection

Property Value

Type: Microsoft.SqlServer.Management.Smo.UserDefinedMessageCollection
A UserDefinedMessageCollection object that represents all the user-defined messages defined on the instance of SQL Server.

Remarks

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.

Examples

Visual Basic

'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

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
foreach ($sr in $srv.UserDefinedMessages)
{
   Write-Host $sr.Name
}