EOS_Platform_GetActiveCountryCode

EOS API reference page for EOS_Platform_GetActiveCountryCode

Remarks

This only will return the value set as the override otherwise EOS_NotFound is returned. This is not currently used for anything internally.

Return Value

  • An EOS_EResult that indicates whether the active country 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 not an override country code for the user.

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

See Also

eos_ecom.h, EOS_COUNTRYCODE_MAX_LENGTH

Parameters

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_COUNTRYCODE_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.