Sphyrnidae Common Library  2.0.1
Shared Utilities/Library
Sphyrnidae.Common.Environment.SettingsEnvironmental Class Reference

Wrapper/Helper class around retrieving environmental variables More...

Static Public Member Functions

static string Get (IEnvironmentSettings settings, string name, string defaultValue=null)
 Retrieves an environmental variable value More...
 

Detailed Description

Wrapper/Helper class around retrieving environmental variables

Member Function Documentation

◆ Get()

static string Sphyrnidae.Common.Environment.SettingsEnvironmental.Get ( IEnvironmentSettings  settings,
string  name,
string  defaultValue = null 
)
static

Retrieves an environmental variable value

Parameters
settingsThe instance of the IEnvironmentSettings interface
nameThe name of the environmental variable
defaultValueIf the environmental variable is not found in the collection from IEnvironmentSettings.Get(), this will be returned instead
Returns
The string value of the environmental variable (If you need to convert to something else, that will be done outside this call)

The documentation for this class was generated from the following file: