SqlCacheDependencyAdmin.EnableNotifications(String) Method

Reference

Definition

Namespace:: System.Web.Caching

Assembly:: System.Web.dll

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.

Enables SqlCacheDependency change notifications on the specified database.

public:
 static void EnableNotifications(System::String ^ connectionString);

public static void EnableNotifications (string connectionString);

static member EnableNotifications : string -> unit

Public Shared Sub EnableNotifications (connectionString As String)

Parameters

connectionString: String

A connection string used to connect to the SQL Server database.

Exceptions

HttpException

A connection to the database could not be established.

-or-

The security context of the ASP.NET application does not have permission to connect to the database.

-or-

The security context of the ASP.NET application does not have permission to disable notifications for the database.

Examples

The following code example uses the EnableNotifications method to enable change notifications for the database specified by the connection string MyConnectionString.

For the full code required to run the example, see the Example section of the SqlCacheDependencyAdmin class overview topic.

protected void enableNotification_Click(object sender, EventArgs e)
{
  SqlCacheDependencyAdmin.EnableNotifications(
    ConfigurationManager.ConnectionStrings["MyConnectionString"].ConnectionString);
}

Protected Sub enableNotification_Click(ByVal sender As Object, ByVal e As System.EventArgs)
  SqlCacheDependencyAdmin.EnableNotifications( _
      ConfigurationManager.ConnectionStrings("MyConnectionString").ConnectionString)
End Sub

Remarks

The EnableNotifications method adds support for change notifications from the database specified in the connectionString parameter. Once you have run the EnableNotifications method, you must run the DisableNotifications method if you wish to disable change notifications for a database.

Applies to