EOS API reference page for EOS_ProductUserId_ToString

2 mins to read


Retrieve a null-terminated stringified Product User ID from an EOS_ProductUserId. This is useful for replication of Product User IDs in multiplayer games. This string will be no larger than EOS_PRODUCTUSERID_MAX_LENGTH + 1 and will only contain UTF8-encoded printable characters as well as the null-terminator.

Return Value

  • An EOS_EResult that indicates whether the Product User ID string was copied into the OutBuffer.

  • EOS_Success - The OutBuffer was filled, and InOutBufferLength contains the number of characters copied into OutBuffer including the null-terminator.

  • EOS_InvalidParameters - Either OutBuffer or InOutBufferLength were passed as NULL parameters.

  • EOS_InvalidUser - The AccountId is invalid and cannot be stringified.

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



Parameter Type And NameUsage Information
EOS_ProductUserId AccountIdThe Product User ID for which to retrieve the stringified version.
char* OutBufferThe buffer into which the character data should be written
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 including the null-termination character.