SqlNotificationRequest.UserData Property

Reference

Definition

Namespace:: Microsoft.Data.Sql

Assembly:: Microsoft.Data.SqlClient.dll

Package:: Microsoft.Data.SqlClient v1.0.19269.1

Package:: Microsoft.Data.SqlClient v1.1.4

Package:: Microsoft.Data.SqlClient v2.0.1

Package:: Microsoft.Data.SqlClient v2.1.4

Package:: Microsoft.Data.SqlClient v3.0.1

Package:: Microsoft.Data.SqlClient v3.1.0

Package:: Microsoft.Data.SqlClient v4.0.1

Package:: Microsoft.Data.SqlClient v4.1.0

Package:: Microsoft.Data.SqlClient v5.0.0

Package:: Microsoft.Data.SqlClient v5.1.0

Package:: Microsoft.Data.SqlClient v5.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to

Share via