SqlNotificationRequest.Options Property

 

Gets or sets the SQL Server Service Broker service name where notification messages are posted.

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

Public Property Options As String

Property Value

Type: System.String

string that contains the SQL Server 2005 Service Broker service name where notification messages are posted and the database or service broker instance GUID to scope the server name lookup.

Exception Condition
ArgumentNullException

The value is NULL.

ArgumentException

The value is longer than uint16.MaxValue.

The value of the Options property has the following format:

service=<service-name>{;(local database=<database>|broker instance=<broker instance>)}

For example, if you use the service "myservice" in the database "AdventureWorks" the format is:

service=myservice;local database=AdventureWorks

The SQL Server Service Broker service must be previously configured on the server. In addition, a Service Broker service and queue must be defined and security access granted as needed. See the SQL Server 2005 documentation for more information.

.NET Framework
Available since 2.0
Return to top
Show: