This documentation is archived and is not being maintained.

SqlNotificationRequest.Options Property

Note: This property is new in the .NET Framework version 2.0.

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 string Options { get; set; 
/** @property */
public String get_Options ()

/** @property */
public void set_Options (String value)

public function get Options () : String

public function set Options (value : String)

Property Value

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 typeCondition

ArgumentNullException

The value is NULL.

.InvalidArgumentException

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; 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.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: