EOS_Platform_GetActiveLocaleCode

EOS API reference page for EOS_Platform_GetActiveLocaleCode

Choose your implementation method:

C

C#

Remarks

Get the active locale code that the SDK will send to services which require it. This returns the override value otherwise it will use the locale code of the given user. This is used for localization. This follows ISO 639.

Return Value

  • An EOS_EResult that indicates whether the active locale code string was copied into the OutBuffer.

  • EOS_Success if the information is available and passed out in OutBuffer

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_NotFound if there is neither an override nor an available locale code for the user.

  • EOS_LimitExceeded - The OutBuffer is not large enough to receive the locale code string. InOutBufferLength contains the required minimum length to perform the operation successfully.

See Also

eos_ecom.h, EOS_LOCALECODE_MAX_LENGTH

Parameters

EOS_Platform_GetActiveLocaleCode

Parameter Type And Name

Usage Information

EOS_HPlatform Handle

EOS_EpicAccountId LocalUserId

The account to use for lookup if no override exists.

char* OutBuffer

The buffer into which the character data should be written. The buffer must be long enough to hold a string of EOS_LOCALECODE_MAX_LENGTH.

int32_t* InOutBufferLength

The size of the OutBuffer in characters. The input buffer should include enough space to be null-terminated. When the function returns, this parameter will be filled with the length of the string copied into OutBuffer.

Remarks

Get the active locale code that the SDK will send to services which require it. This returns the override value otherwise it will use the locale code of the given user. This is used for localization. This follows ISO 639. The input buffer should include enough space to be null-terminated. When the function returns, this parameter will be filled with the length of the string copied into OutBuffer. {Result.Success} if the information is available and passed out in OutBuffer {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.NotFound} if there is neither an override nor an available locale code for the user. {Result.LimitExceeded} - The OutBuffer is not large enough to receive the locale code string. InOutBufferLength contains the required minimum length to perform the operation successfully.

Return Value

An {Result} that indicates whether the active locale code string was copied into the OutBuffer.

See Also

eos_ecom.h, {LocalecodeMaxLength}

Parameters

Platform.PlatformInterface.GetActiveLocaleCode

Parameter Type And Name

Usage Information

EpicAccountId localUserId

The account to use for lookup if no override exists.

string outBuffer

The buffer into which the character data should be written. The buffer must be long enough to hold a string of EOS_LOCALECODE_MAX_LENGTH.