SqlNotificationRequest Constructor (String, String, Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Creates a new instance of the SqlNotificationRequest class with a user-defined string that identifies a particular notification request, the name of a predefined SQL Server 2005 Service Broker service name, and the time-out period, measured in seconds.

Namespace:   System.Data.Sql
Assembly:  System.Data (in System.Data.dll)

public SqlNotificationRequest(
	string userData,
	string options,
	int timeout
)

Parameters

userData
Type: System.String

A string that contains an application-specific identifier for this notification. It is not used by the notifications infrastructure, but it allows you to associate notifications with the application state. The value indicated in this parameter is included in the Service Broker queue message.

options
Type: System.String

A string that contains the Service Broker service name where notification messages are posted, and it must include a database name or a Service Broker instance GUID that restricts the scope of the service name lookup to a particular database.

For more information about the format of the options parameter, see Options.

timeout
Type: System.Int32

The time, in seconds, to wait for a notification message.

Exception Condition
ArgumentNullException

The value of the options parameter is NULL.

ArgumentOutOfRangeException

The options or userData parameter is longer than uint16.MaxValue or the value in the timeout parameter is less than zero.

This constructor allows you to initialize a new SqlNotificationRequest instance, providing your own identifier, the SQL Server 2005 Service Broker service name, and a time-out value.

.NET Framework
Available since 2.0
Return to top
Show: