Expand Minimize

MI_Context_GetLocale function

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

Syntax


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

Parameters

context [in]

A pointer to the request context.

localeType

The type of locale to be returned.

locale[MI_MAX_LOCALE_SIZE]

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.

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

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

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

 

 

Show:
© 2014 Microsoft