Version: 2023.1
LanguageEnglish
  • C#

ReadHandle.GetBytesRead

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public long GetBytesRead();

Returns

long The total number of bytes read by the asynchronous file read request.

Description

Returns the total number of bytes read by all the ReadCommand operations the asynchronous file read request.

This may not be equal to the sum of all the requested ReadCommand.Size fields in the case of a ReadStatus.Failed error or a ReadStatus.Truncated status.

A truncated read occurs when the ReadCommand describing the read operation specifies a ReadCommand.Size and ReadCommand.Offset that extends past the end of the target file.


Declaration

public long GetBytesRead(uint readCommandIndex);

Parameters

readCommandIndex The index of the ReadCommand for which to retrieve the number of bytes read.

Returns

long The number of bytes read for the specified ReadCommand.

Description

Returns the total number of bytes read for a specific ReadCommand index.

This may not be equal the requested ReadCommand.Size fields in the case of a ReadStatus.Failed error or a ReadStatus.Truncated status.

A truncated read occurs when the ReadCommand describing the read operation specifies a ReadCommand.Size and ReadCommand.Offset that extends past the end of the target file.