RoleEnvironmentGetConfigurationSetting Function

 

Returns the value of the named configuration setting from the service configuration file.

Syntax

STDAPI RoleEnvironmentGetConfigurationSettingValue(__in LPCTSTR roleSettingName,__out_ecount(cchDest) LPTSTR pszDest,__in size_t cchDest,__out_opt size_t *pcchRequiredDestSize);

Parameters

  • roleSettingName
    Required. The name of the configuration setting to retrieve.

  • pszDest
    Required. Buffer to receive the value of the configuration setting.

  • cchDest
    Required. Maximum size of the pszDest buffer.

  • pcchRequiredDestSize
    Optional. Contains the required size of the pszDest buffer if the current buffer is too small.

Return Value

Use the SUCCEEDED macro to determine whether a call to the RoleEnvironmentGetConfigurationSettingValue function has succeeded or failed.

If the call fails due to the value of cchDest being too small, the RoleEnvironmentGetConfigurationSettingValue function returns the ROLEENVIRONMENT_E_INSUFFICIENT_BUFFER constant.

For more information, see Return Codes.

Remarks

None.

Function Information

Header File

ServiceRuntime.h

Import Library

<Azure SDK installation directory>\lib\x64\mswar.lib

<Azure SDK installation directory>\lib\x86\mswar.lib