EssGetServerLocaleString

Gets the server locale description; for example, English_UnitedStates.US-ASCII@Default.

Syntax

ESS_FUNC_M EssGetServerLocaleString (hCtx, localeString);
ParameterData TypeDescription

hCtx;

ESS_HCTX_T

Context handle

localeString;

ESS_PSTR_T

Address of pointer to receive allocated string of server locale description.

Notes

The memory allocated for localeString should be freed using EssFree().

Return Value

If successful, returns the name of the server locale description in localeString.

Access

This function requires no special privileges.

Example

  ESS_FUNC_M
  ESS_GetServerLocaleString (ESS_HCTX_T  hCtx)
  {
     ESS_FUNC_M     sts = ESS_STS_NOERR;
     ESS_STR_T localeStr= NULL;
  
     sts = EssGetServerLocaleString(hCtx, &localeStr);
     
     if (localeStr)
     {
        printf("server locale: %s\r\n",localeStr);
        EssFree(hInst,localeStr);
     }
     return sts;
  }