IConfigureDatabase.UnRegisterDatabaseServer Method

Syntax

The syntax of the UnRegisterDatabaseServer method is:

UnRegisterDatabaseServer(DatabaseServerRegistrationParamters databaseServerParameters);

Argument

databaseServerParameters: DatabaseServerRegistrationParameters object

The object describes all the values available from the DatabaseServerRegistrationParameters classes.

The DatabaseServerRegistrationParameters class exposes the following members for removing a database server alias.

Members of DatabaseParameter class

Name

Type

Description

DBAlias

String

The alias name to register

Return Value

If this method succeeds, it returns the StatusInfo object with the status code; Error, Warning, or Success and status message, if any.

Using the IConfigureDatabase Interface for UnRegisterDatabaseServer Method

using Unisys.AgileBusiness.RuntimeAPI;
IConfigureDatabase databaseConfig = RuntimeFactory.GetConfigDB();
            DatabaseServerRegistrationParamters parameter = new DatabaseServerRegistrationParamters()
            {
                               DBAlias = " Default"
            };
            StatusInfo status = databaseConfig.UnRegisterDatabaseServer(parameter);

Definition of the IConfigureDatabase Interface

namespace Unisys.AgileBusiness.RuntimeAPI
{
    public interface IConfigureDatabase
    {
        StatusInfo CreateDatabase(DatabaseParameters databaseParameters);
        StatusInfo DeleteDatabase(DatabaseParameters databaseParameters);
        StatusInfo AttachDatabase(DatabaseParameters databaseParameters);
        StatusInfo DetachDatabase(DatabaseParameters databaseParameters);
        StatusInfo RegisterDatabaseServer(DatabaseServerRegistrationParamters
        databaseServerParameters);
        StatusInfo UnRegisterDatabaseServer(DatabaseServerRegistrationParamters
        databaseServerParameters);
    }
}