SqlNotificationRequest.UserData Property

Definition

Namespace:

System.Data.Sql

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.8.6

Gets or sets an application-specific identifier for this notification.

public:
 property System::String ^ UserData { System::String ^ get(); void set(System::String ^ value); };

public string UserData { get; set; }

member this.UserData : string with get, set

Public Property UserData As String

Property Value

String

A string value of the application-specific identifier for this notification.

Exceptions

ArgumentException

The value is longer than uint16.MaxValue.

Remarks

This value is not used by the notifications infrastructure. Instead, it is a mechanism that allows an application to associate notifications with application state. The value specified in the UserData property is included in the SQL Server 2005 queue message.

See also

• Using Query Notifications