Share via


BackupDataInput.ReadNextHeader Method

Definition

Extract the next entity header from the restore stream.

[Android.Runtime.Register("readNextHeader", "()Z", "GetReadNextHeaderHandler")]
public virtual bool ReadNextHeader ();
[<Android.Runtime.Register("readNextHeader", "()Z", "GetReadNextHeaderHandler")>]
abstract member ReadNextHeader : unit -> bool
override this.ReadNextHeader : unit -> bool

Returns

true when there is an entity ready for consumption from the restore stream, false if the restore stream has been fully consumed.

Attributes

Exceptions

if an error occurred while reading the restore stream

Remarks

Extract the next entity header from the restore stream. After this method return success, the #getKey() and #getDataSize() methods can be used to inspect the entity that is now available for processing.

Java documentation for android.app.backup.BackupDataInput.readNextHeader().

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to