EOS_Connect_GetProductUserIdMapping

EOS API reference page for EOS_Connect_GetProductUserIdMapping

2 mins to read

This function is part of the Connect Interface.

Remarks

Fetch an external account ID, in string form, that maps to a given Product User ID.

Return Value

  • An EOS_EResult that indicates the external account ID was copied into the OutBuffer.

  • EOS_Success if the information is available and passed out in OutUserInfo.

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

  • EOS_NotFound if the mapping doesn't exist or hasn't been queried yet.

  • EOS_LimitExceeded if the OutBuffer is not large enough to receive the external account ID. InOutBufferLength contains the required minimum length to perform the operation successfully.

Parameters

EOS_Connect_GetProductUserIdMapping

Parameter Type And NameUsage Information
EOS_HConnect Handle
const EOS_Connect_GetProductUserIdMappingOptions* Optionsstructure containing the local user and target Product User ID.
char* OutBufferThe buffer into which the external account ID data should be written. The buffer must be long enough to hold a string of EOS_CONNECT_EXTERNAL_ACCOUNT_ID_MAX_LENGTH.
int32_t* InOutBufferLengthThe 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.