ByteDev.Configuration.Environment 1.2.0

ByteDev.Configuration.Environment

Library to help when accessing environment variables.

Installation

ByteDev.Configuration.Environment is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:

Install-Package ByteDev.Configuration.Environment

Further details can be found on the nuget page.

Release Notes

Releases follow semantic versioning.

Full details of the release notes can be viewed on GitHub.

Usage

The primary class for accessing environment variable is EnvironmentVariableProvider (IEnvironmentVariableProvider).

EnvironmentVariableProvider has the following methods:

• Delete
• Exists
• GetBool
• GetBoolOrDefault
• GetGuid
• GetByte
• GetByteOrDefault
• GetShort
• GetShortOrDefault
• GetInt
• GetIntOrDefault
• GetLong
• GetLongOrDefault
• GetFloat
• GetFloatOrDefault
• GetDouble
• GetDoubleOrDefault
• GetDecimal
• GetDecimalOrDefault
• GetUri
• GetString
• GetStringOrDefault
• Set

// Initialize provider with an optional target level
IEnvironmentVariableProvider provider = new EnvironmentVariableProvider(EnvironmentVariableTarget.Process);

provider.Set("MyVar1", "Value1");

var exists = provider.Exists("MyVar1");         // exists == true

string val1 = provider.GetString("MyVar1");     // val1 == "Value1"

string val2 = provider.GetString("MyVar2");     // throws EnvironmentVariableNotExistException

string val3 = provider.GetStringOrDefault("MyVar3");                 // val3 == null

string val4 = provider.GetStringOrDefault("MyVar3", "myDefault");    // val3 == "myDefault"

provider.Delete("MyVar1");

provider.Delete("DoesNotExist");                // Does not throw exception

provider.Set("MyUri1", "http://www.google.com/");
provider.Set("MyUri2", "ThisIsNotUri");

Uri uri0 = provider.GetUri("MyUri0");       // throws EnvironmentVariableNotExistException

Uri uri1 = provider.GetUri("MyUri1");       // uri1 == new Uri("http://www.google.com/")

Uri uri2 = provider.GetUri("MyUri2");       // throws UnexpectedEnvironmentVariableTypeException