zlib.ZStream.Sync

zlib.ZStream.Sync

Method Signature

 Function Sync(MaxCount As Integer = -1) As Boolean

Parameters

Name	Type	Comment
MaxCount	Integer	Optional. The maximum number of compressed bytes to read.

Return value

Returns True if a possible flush point was detected.

Remarks

This method is only available when the input stream is a BinaryStream.

This method reads compressed bytes from the input stream until a possible full flush point is detected. If a flush point was found then the decompressor is reset and switches to RAW_ENCODING, the Position property of the BinaryStream is moved to the flush point, and this method returns True.

If no flush point was found before reaching the MaxCount or EOF, the Position property of the BinaryStream is returned to its original value and this method returns False.

See also

• Inflater.SyncToNextFlush
• ZStream.Flush