Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetBytesRead

Returns the total number of bytes read by all the ReadCommand operations the asynchronous file read request.
Read time 1 minuteLast updated 12 days ago

Definition

GetBytesRead()

Returns the total number of bytes read by all the ReadCommand operations the asynchronous file read request.
public long GetBytesRead()

Returns

Type

Description

longThe total number of bytes read by the asynchronous file read request.

Remarks

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.

GetBytesRead(uint)

Returns the total number of bytes read for a specific ReadCommand index.
public long GetBytesRead(uint readCommandIndex)

Parameters

readCommandIndex

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

Returns

Type

Description

longThe number of bytes read for the specified ReadCommand.

Remarks

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.