Server.UserDefinedMessages Server.UserDefinedMessages Server.UserDefinedMessages Property

Definition

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

public:
 property Microsoft::SqlServer::Management::Smo::UserDefinedMessageCollection ^ UserDefinedMessages { Microsoft::SqlServer::Management::Smo::UserDefinedMessageCollection ^ get(); };
[Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcObject(Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcContainerRelationship.ObjectContainer, Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcContainerCardinality.ZeroToAny, typeof(Microsoft.SqlServer.Management.Smo.UserDefinedMessage))]
public Microsoft.SqlServer.Management.Smo.UserDefinedMessageCollection UserDefinedMessages { get; }
Public ReadOnly Property UserDefinedMessages As UserDefinedMessageCollection
Property Value

A UserDefinedMessageCollection object that represents all the user-defined messages defined on the instance of SQL Server.

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  
}  

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.

Applies to