Skip to main content

EOS_ProductUserId_ToString

Function EOS_ProductUserId_ToString 

Source
pub unsafe extern "C" fn EOS_ProductUserId_ToString(
    AccountId: EOS_ProductUserId,
    OutBuffer: *mut c_char,
    InOutBufferLength: *mut i32,
) -> EOS_EResult
Expand description

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.

@param AccountId The Product User ID for which to retrieve the stringified version. @param OutBuffer The buffer into which the character data should be written @param 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 including the null-termination character.

@return 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.