SqlNotificationRequest.Options Property

Definition

Namespace:

Microsoft.Data.Sql

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

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

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

public string Options { get; set; }

member this.Options : string with get, set

Public Property Options As String

Property Value

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.

Exceptions

ArgumentNullException

The value is NULL.

ArgumentException

The value is longer than uint16.MaxValue.

Remarks

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.

See also

• Using Query Notifications