Get Windows Service Name From App.Config In Installation

Introduction

Sometimes it is required to make the Windows service name configuration based. It means service name will fetch from App.config and install the service with the same name. In a simple way, it is not fetching the  correct value from App.config at the time of installation. Because the exe running Installer is InstallUtil.exe and ConfigurationManager will look for InstallUtil.exe.config, it provides the wrong result. Follow the below steps to achieve this. 

Implementation

Step 1

Add following appSetting key in App.config to have service name.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.1"/>
  </startup>
  <appSettings>
    <add key="ServiceName" value="ServiceMonitorV1"/>
  </appSettings>
</configuration>

Next, right click on App.config and select properties. Change below two properties values,

Build Action -> None

Copy to Output Directory -> Copy Always

Follow below screen,

 

Step 2

Add method to fetch value from App.config. Below method fetches assembly information and its location.

Next it fetches the config directory based on assembly location. 

public string GetServiceName()
{
    string serviceName = string.Empty;

    try
    {
        Assembly executingAssembly = Assembly.GetAssembly(typeof(ProjectInstaller));
        string targetDir = executingAssembly.Location;
        Configuration config = ConfigurationManager.OpenExeConfiguration(targetDir);
        serviceName = config.AppSettings.Settings["ServiceName"].Value.ToString();

        return serviceName;
    }
    catch (Exception ex)
    {
        return "MyWinService";
    }
}

Step 3

Call above method in ProjectInstaller.Designer.cs and ProjectInstaller.cs

// ProjectInstaller.Designer.cs
this.serviceInstaller1.ServiceName = new CommonUtil().GetServiceName();

// ProjectInstaller.cs
private void ServiceInstaller_AfterInstall(object sender, InstallEventArgs e)
{
    ServiceController sc = new ServiceController(new CommonUtil().GetServiceName());
    sc.Start();
}

Conslusion

 

In this blog we discussed how to get Service name from App.config file at the time of installation. Hope it helps.