NSInstance.StopInstance Method

Article
12/03/2008

Stops the Notification Services engine for an instance of Notification Services.

Namespace: Microsoft.SqlServer.NotificationServices
Assembly: Microsoft.SqlServer.NotificationServices (in microsoft.sqlserver.notificationservices.dll)

Syntax

'Declaration
Public Sub StopInstance

public void StopInstance ()

public:
virtual void StopInstance () sealed

public final void StopInstance ()

public final function StopInstance ()

Remarks

On each computer that runs components of an instance of Notification Services, there is one Notification Services engine. This engine can be hosted by the NS$instanceNameMicrosoft Windows service, which can be created when you register an instance of Notification Services, or can be hosted by a custom application or service.

You can start and stop an instance of Notification Services on a computer using the StartInstance and StopInstance methods.

Important

Only one process can own an instance of Notification Services at a time. If your process did not start the instance, it cannot stop the instance. If the reference to the object that started the instance is lost, the instance is stopped during garbage collection.

For more information about hosting the engine, see Hosting the Notification Services Engine.

Example

The following examples show how to create, initialize, and stop an NSInstance object in managed code:

' Stop an instance of Notification Services 
' that is being hosted by this process.
Public Sub StopInstance(ByVal myInstance As NSInstance)
    Try
        myInstance.StopInstance()
    Catch ex As Exception
        Console.WriteLine(ex.Message)
    End Try
End Sub

HostedEngine#NSCS_StopHostedInstance

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms