# EssGetServerLocaleString

Description

EssGetServerLocaleString() gets the server locale description; for example, English_UnitedStates.US-ASCII@Default.

Syntax

    ESS_FUNC_M EssGetServerLocaleString (hCtx, localeString);

ESS_HCTX_T | hCtx;
ESS_PSTR_T | localeString;

Parameters

hCtx | Context handle
localeString | Address of pointer to receive allocated string of server locale description.

Return Value

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

Notes

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

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;
      }