MI_Context_GetLocale function (mi.h)

Retrieves the requested locale information that the client specified for the operation.

Syntax

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_GetLocale(
  [in] const MI_Context             *context,
       MI_LocaleType                localeType,
       MI_Char [MI_MAX_LOCALE_SIZE] locale
);

Parameters

[in] context

A pointer to the request context.

localeType

The type of locale to be returned.

locale

The returned locale.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Remarks

There are two types of locale: UI and Data. UI relates to the language of strings. Data relates to data formatting, such as date/time formats in strings and whether a decimal point or some other separator is used.

Requirements