Framework EDI Reference. Methods and Properties
ediFileSystem. UnzipFile

Decompresses the contents of a file to a target file.

Syntax:

• <lRetVal> = object.UnzipFile(<sCompressedFile>, <lCompressionMethod>, <sTargetFile>);
•  

Parameters:

• sCompressedFile – Full path name of file to decompress.
• lCompressionMethod – Compression method used to decompress the contents of the file.  Only the supported mechanisms listed in Compression Method Type ID Constants are allowed.
• sTargetFile – Full path name of the target file that will contain the decompressed data.

Returns

Returns 1 if the operation is successful; otherwise the operation returns zero.

Remarks

The same compression method used to compress the file must be used to decompress, otherwise an error is generated.

Example

Dim oEdiDoc As Fredi.ediDocument
Dim oFileSystem As Fredi.ediFileSystem

' Create instance of Framework EDI.
Set oEdiDoc = New Fredi.ediDocument

' Get file system object.
Set oFileSystem = oEdiDoc.GetFileSystem

' Decompress using ZIPINFO
oFileSystem.UnzipFile App.Path & "\ZipFile_ZipInfo.zip", CompressMethod_ZipInfo, App.Path & "\Unzipped_ZipInfo.TXT"

' Decompress using ZLIB
oFileSystem.UnzipFile App.Path & "\ZipFile_ZLib.zip", CompressMethod_ZLib, App.Path & "\Unzipped_Zlib.TXT"

MsgBox "Done"

Samples

• M_UnzipFile.zip