EOS_ProductUserId_ToString

EOS API reference page for EOS_ProductUserId_ToString

Choose your implementation method:

C

C#

Remarks

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 (excluding 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.

Parameters

EOS_ProductUserId_ToString

Parameter Type And Name

Usage Information

EOS_ProductUserId AccountId

The Product User ID for which to retrieve the stringified version.

char* OutBuffer

The buffer into which the character data should be written

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 including the null termination character.

Remarks

Retrieve a null-terminated stringified Product User ID from an {ProductUserId}. This is useful for replication of Product User IDs in multiplayer games. This string will be no larger than {ProductuseridMaxLength} + 1 and will only contain UTF8-encoded printable characters (excluding the null-terminator). 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. {Result.Success} - The OutBuffer was filled, and InOutBufferLength contains the number of characters copied into OutBuffer including the null terminator. {Result.InvalidParameters} - Either OutBuffer or InOutBufferLength were passed as NULL parameters. {Result.InvalidUser} - The AccountId is invalid and cannot be stringified. {Result.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.

Return Value

An {Result} that indicates whether the Product User ID string was copied into the OutBuffer.

Parameters

ProductUserId.ToString

Parameter Type And Name

Usage Information

string outBuffer

The buffer into which the character data should be written