zlib.Inflate

#zlib.Inflate

##Method Signatures

 Protected Function Inflate(Source As FolderItem, Dictionary As MemoryBlock = Nil, Encoding As Integer = zlib.DEFLATE_ENCODING) As MemoryBlock
 Protected Function Inflate(Source As MemoryBlock, Dictionary As MemoryBlock = Nil, Encoding As Integer = zlib.DEFLATE_ENCODING) As MemoryBlock
 Protected Function Inflate(Source As Readable, Dictionary As MemoryBlock = Nil, Encoding As Integer = zlib.DEFLATE_ENCODING) As MemoryBlock
 Protected Function Inflate(Source As FolderItem, Destination As FolderItem, Overwrite As Boolean = False, Dictionary As MemoryBlock = Nil, Encoding As Integer = zlib.DEFLATE_ENCODING) As Boolean
 Protected Function Inflate(Source As MemoryBlock, Destination As FolderItem, Overwrite As Boolean = False, Dictionary As MemoryBlock = Nil, Encoding As Integer = zlib.DEFLATE_ENCODING) As Boolean
 Protected Function Inflate(Source As Readable, Destination As FolderItem, Overwrite As Boolean = False, Dictionary As MemoryBlock = Nil, Encoding As Integer = zlib.DEFLATE_ENCODING) As Boolean
 Protected Function Inflate(Source As Readable, Destination As Writeable, Dictionary As MemoryBlock = Nil, Encoding As Integer = zlib.DEFLATE_ENCODING) As Boolean

##Parameters

Name	Type	Comment
Source	FolderItem, Readable, MemoryBlock	The data to decompress
Destination	FolderItem, Writeable	The file or stream to which decompressed data should be written. Methods which return a MemoryBlock do not have this parameter
Overwrite	Boolean	If True, the Destination FolderItem will be overwritten if it exists. Only those methods with FolderItem destinations have this parameter
Dictionary	MemoryBlock	Optional, if specified the dictionary used by the compressor
Encoding	Integer	Optional, if specified the type of compression used by the compressor

##Return value Returns True if there were no errors writing to a Writeable or FolderItem; or, a MemoryBlock containing the decompressed data.

##Notes Decompresses data from the Source argument into the Destination argument; methods without a Destination argument return the decompressed data instead.

Calling this method with the default parameters produces the same output as zlib.Uncompress. The difference is that the size of the input to this method is not limited by available memory whereas zlib.Uncompress has less memory overhead.

#Examples Decompress a string into a string:

  Dim data As String = zlib.Compress("hello, world!") ' some compressed data
  Dim inflated As String = zlib.Inflate(data)

Decompress a string into a file:

  Dim data As String = zlib.Compress("hello, world!") ' some compressed data
  Dim inflated As FolderItem = SpecialFolder.Desktop.Child("example.bin")
  If Not zlib.Inflate(data, inflated) Then
    MsgBox("Inflate error!")
  End If

Decompress a file into a string:

  Dim data As FolderItem = SpecialFolder.Desktop.Child("example.bin") ' a compressed file
  Dim inflated As String = zlib.Inflate(data)

##See also

• zlib.Deflate