MI_DestinationOptions_GetDataLocale function (mi.h)

Gets the data locale (as opposed to UI locale) set by the user.

Syntax

MI_INLINE MI_Result MI_DestinationOptions_GetDataLocale(
  [in] MI_DestinationOptions *options,
       const MI_Char         **locale
);

Parameters

[in] options

MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.

locale

A pointer to a null-terminated string containing the returned data locale. The memory is owned by the destination options object, so it does not need to be deleted.

Return value

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

Remarks

The data locale determines string formats for entities such as decimal numbers in string format and date/time formats.

Requirements