SqlDependency.Start Method
Definition
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.
Overloads
| Start(String) |
Starts the listener for receiving dependency change notifications from the instance of SQL Server specified by the connection string. |
| Start(String, String) |
Starts the listener for receiving dependency change notifications from the instance of SQL Server specified by the connection string using the specified SQL Server Service Broker queue. |
Start(String)
Starts the listener for receiving dependency change notifications from the instance of SQL Server specified by the connection string.
public:
static bool Start(System::String ^ connectionString);public static bool Start (string connectionString);static member Start : string -> boolPublic Shared Function Start (connectionString As String) As BooleanParameters
- connectionString
- String
The connection string for the instance of SQL Server from which to obtain change notifications.
Returns
true if the listener initialized successfully; false if a compatible listener already exists.
Exceptions
The connectionString parameter is NULL.
The connectionString parameter is the same as a previous call to this method, but the parameters are different.
The method was called from within the CLR.
The caller does not have the required SqlClientPermission code access security (CAS) permission.
A subsequent call to the method has been made with an equivalent connectionString parameter with a different user, or a user that does not default to the same schema.
Also, any underlying SqlClient exceptions.
Remarks
This method starts the listener for the AppDomain for receiving dependency notifications from the instance of SQL Server specified by the connectionString parameter. This method may be called more than once with different connection strings for multiple servers.
For additional remarks, see Start.
See also
Applies to
Start(String, String)
Starts the listener for receiving dependency change notifications from the instance of SQL Server specified by the connection string using the specified SQL Server Service Broker queue.
public:
static bool Start(System::String ^ connectionString, System::String ^ queue);public static bool Start (string connectionString, string queue);static member Start : string * string -> boolPublic Shared Function Start (connectionString As String, queue As String) As BooleanParameters
- connectionString
- String
The connection string for the instance of SQL Server from which to obtain change notifications.
- queue
- String
An existing SQL Server Service Broker queue to be used. If null, the default queue is used.
Returns
true if the listener initialized successfully; false if a compatible listener already exists.
Exceptions
The connectionString parameter is NULL.
The connectionString parameter is the same as a previous call to this method, but the parameters are different.
The method was called from within the CLR.
The caller does not have the required SqlClientPermission code access security (CAS) permission.
A subsequent call to the method has been made with an equivalent connectionString parameter but a different user, or a user that does not default to the same schema.
Also, any underlying SqlClient exceptions.
Remarks
This method starts the listener for the AppDomain for receiving dependency notifications from the instance of SQL Server specified by the connectionString parameter. This method may be called more than once with different connection strings for multiple servers.
If no queue name is specified, SqlDependency creates a temporary queue and service in the server that is used for the entire process, even if the process involves more than one AppDomain. The queue and service are automatically removed upon application shutdown.
For additional remarks, see Start.