Export (0) Print
Expand All
Expand Minimize

MI_DestinationOptions_SetUILocale function

Sets the default UI locale for operations.

Syntax


MI_Result MI_DestinationOptions_SetUILocale(
  _Inout_  MI_DestinationOptions *options,
  _In_z_ const MI_Char *locale
);

Parameters

options [in, out]

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.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error 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

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_DestinationOptions
MI_Application_NewDestinationOptions
MI_DestinationOptions_GetUILocale

 

 

Show:
© 2014 Microsoft