Equivalent to ‘app.config’ for a library (DLL)

by

You can have separate configuration file, but you’ll have to read it “manually”, the ConfigurationManager.AppSettings["key"] will read only the config of the running assembly.

Assuming you’re using Visual Studio as your IDE, you can right click the desired project → Add → New item → Application Configuration File

This will add App.config to the project folder, put your settings in there under <appSettings> section. In case you’re not using Visual Studio and adding the file manually, make sure to give it such name: DllName.dll.config, otherwise the below code won’t work properly.

Now to read from this file have such function:

string GetAppSetting(Configuration config, string key)
{
    KeyValueConfigurationElement element = config.AppSettings.Settings[key];
    if (element != null)
    {
        string value = element.Value;
        if (!string.IsNullOrEmpty(value))
            return value;
    }
    return string.Empty;
}

And to use it:

Configuration config = null;
string exeConfigPath = this.GetType().Assembly.Location;
try
{
    config = ConfigurationManager.OpenExeConfiguration(exeConfigPath);
}
catch (Exception ex)
{
    //handle errror here.. means DLL has no sattelite configuration file.
}

if (config != null)
{
    string myValue = GetAppSetting(config, "myKey");
    ...
}

You’ll also have to add reference to System.Configuration namespace in order to have the ConfigurationManager class available.

When building the project, in addition to the DLL you’ll have DllName.dll.config file as well, that’s the file you have to publish with the DLL itself.

Within the VS project, you should set the .config file “Copy to output directory” setting to “Always Copy”.

The above is basic sample code, for those interested in a full scale example, please refer to this other answer.

More Related Contents:

  1. Embedding DLLs in a compiled executable
  2. What is App.config in C#.NET? How to use it?
  3. System.MissingMethodException: Method not found?
  4. Change default app.config at runtime
  5. Where are the Properties.Settings.Default stored?
  6. Generating DLL assembly dynamically at run time
  7. Embedding assemblies inside another assembly
  8. C# – approach for saving user settings in a WPF application?
  9. Relocating app.config file to a custom path
  10. Use XML includes or config references in app.config to include other config files’ settings
  11. Can a unit test project load the target application’s app.config file?
  12. ConfigurationManager.AppSettings – How to modify and save?
  13. Embedding DLLs in a compiled executable
  14. When using a Settings.settings file in .NET, where is the config actually stored?
  15. Creating simple c++.net wrapper. Step-by-step
  16. How to get the location of the DLL currently executing?
  17. InvalidProgramException / Common Language Runtime detected an invalid program
  18. Can you call a C# DLL from a C DLL?
  19. Update app.config system.net setting at runtime
  20. Could not load file or assembly ‘System.ValueTuple’
  21. Consume a SOAP web service without relying on the app.config
  22. How to enable configSource attribute for Custom Configuration Section in .NET?
  23. Properties.Settings.Default.Save(); -> Where is that file
  24. Target 32 Bit or 64 Bit native DLL depending on environment
  25. Calling a Delphi DLL from a C# .NET application
  26. Read from App.config in a Class Library project
  27. How to write to the main exe’s .config userSettings section?
  28. Can’t find how to use HttpContent
  29. How to find path of active app.config file?
  30. How to modify my App.exe.config keys at runtime?

Leave a Comment