Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetConfigurationSettingValue Method
Collapse the table of content
Expand the table of content

RoleEnvironment.GetConfigurationSettingValue Method (String)

 

Retrieves the value of a setting in the service configuration file.

Namespace:   Microsoft.WindowsAzure.ServiceRuntime
Assembly:  Microsoft.WindowsAzure.ServiceRuntime (in Microsoft.WindowsAzure.ServiceRuntime.dll)

[SecurityPermissionAttribute(SecurityAction.Assert, UnmanagedCode = true)]
public static string GetConfigurationSettingValue(
	string configurationSettingName
)

Parameters

configurationSettingName
Type: System.String

Type: System.String

The name of the configuration setting.

Return Value

Type: System.String

Type: System.String

A String that contains the value of the configuration setting.

Exception Condition
RoleEnvironmentException

The configuration setting that was being retrieved does not exist.

Configuration settings for a role are defined in the ServiceDefinition.csdef file and the values for the settings are configured in the ServiceConfiguration.cscfg file. For more information about defining and configuring settings, see the following information:

The GetConfigurationSettingValue method can be used to retrieve the value that is defined in the ServiceConfiguration.cscfg file. The following code example shows how to get and write out the value for a setting called MySetting:


var settingValue = RoleEnvironment.GetConfigurationSettingValue("MySetting"); 
Trace.WriteLine("The setting value is: " + settingValue, "Information");
Return to top
Show:
© 2015 Microsoft