MI_DestinationOptions_SetUILocale function (mi.h)

Sets the default UI locale for operations.

Syntax

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

Parameters

[in, out] options

A pointer to a MI_DestinationOptions object returned from the MI_Application_NewDestinationOptions function.

locale

A null-terminated string that represents the locale string to be used (for example, "en-us").

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 UI locale represents the language that error messages should come back to the client in. By default, the UI locale of the calling thread for the execution of an operation would be used.

Requirements

See also

MI_Application_NewDestinationOptions

MI_DestinationOptions

MI_DestinationOptions_GetUILocale