Instance.RegisterLocal Method (String, String)

Article
12/03/2008

Registers the instance of Notification Services locally and, if the Microsoft Windows service does not exist, installs the Windows service that runs the Notification Services engine.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Sub RegisterLocal ( _
    serviceUserName As String, _
    servicePassword As String _
)

public void RegisterLocal (
    string serviceUserName,
    string servicePassword
)

public:
void RegisterLocal (
    String^ serviceUserName, 
    String^ servicePassword
)

public void RegisterLocal (
    String serviceUserName, 
    String servicePassword
)

public function RegisterLocal (
    serviceUserName : String, 
    servicePassword : String
)

Parameters

serviceUserName
A String specifying the Windows user name for the instance of Notification Services.

servicePassword
A String specifying the password for the user.

Remarks

Important

Secure any executable and source code that contains passwords.

For information about the permissions required by the Windows service, see Configuring Windows Accounts for an Instance of Notification Services and Configuring SQL Server Permissions for an Instance of Notification Services.

Example

The following examples show how to call a method that configures an instance and its applications, and then create, register, and enable that instance:

// Set Database Engine instance and 
// Notification Services object
server = new smo.Server(sqlServer);
notificationServices = server.NotificationServices;

// Determine if the instance already exists. If so, exit.
if (server.NotificationServices.Instances.Contains(
    instanceName))
{
    Console.WriteLine("Instance exists and will be deleted.");
    myInstance = notificationServices.Instances[instanceName];
    DeleteInstance(myInstance);
}

// Call ConfigureInstance method to configure the instance
// and define the application(s).
myInstance = ConfigureInstance(notificationServices);

// Create the instance
Console.WriteLine("Creating instance...");
myInstance.Create();

//Optional: Export an Instance Configuration File (ICF)
Console.WriteLine("Exporting ICF...");
myInstance.Export(@"C:\NS\Full", true);

// Register and enable the instance
Console.WriteLine("Registering instance...");
myInstance.RegisterLocal(serviceUserName, servicePassword);
Console.WriteLine("Enabling instance...");
myInstance.Enable();
Console.WriteLine("Done.");

' Set Database Engine server and 
' Notification Services object
server = New smo.Server(sqlServer)
notificationServices = server.NotificationServices

' Determine if the instance already exists. If so, exit.
If server.NotificationServices.Instances.Contains( _
  instanceName) Then
    Console.WriteLine( _
        "Instance exists and will be deleted.")
    myInstance = notificationServices.Instances( _
        instanceName)
    DeleteInstance(myInstance)
End If

' Call ConfigureInstance method to configure the instance
' and define the application(s).
myInstance = ConfigureInstance(notificationServices)

' Create the instance
Console.WriteLine("Creating instance...")
myInstance.Create()

'Optional: Export an Instance Configuration File (ICF)
Console.WriteLine("Exporting ICF...")
myInstance.Export("C:\NS\Full", True)

' Register and enable the instance
Console.WriteLine("Registering instance...")
myInstance.RegisterLocal(serviceUserName, servicePassword)
Console.WriteLine("Enabling instance...")
myInstance.Enable()
Console.WriteLine("Done.")

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