Export (0) Print
Expand All
Expand Minimize

MI_DestinationOptions_GetDataLocale function

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,
  _Outptr_result_z_ const MI_Char **locale
);

Parameters

options [in]

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.

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 data locale determines string formats for entities such as decimal numbers in string format and date/time formats.

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