SocketTools .NET Edition

FileEncoder.ExpandFile Method (String, String, CompressionType)

Expands the contents of a previously compressed file.

[Visual Basic]
Overloads Public Function ExpandFile( _
   ByVal inputFile As String, _
   ByVal outputFile As String, _
   ByVal compressionType As CompressionType _
) As Boolean
[C#]
public bool ExpandFile(
   string inputFile,
   string outputFile,
   CompressionType compressionType
);

Parameters

inputFile
A string which specifies the name of the file to be compressed. The file must exist, and it must be a regular file that can be opened for reading by the current process. An error will be returned if a character device, such as CON: is specified as the file name.
outputFile
The name of the file that is to contain the expanded file data. If the file exists, it must be a regular file that can be opened for writing by the current process and will be overwritten. If the file does not exist, it will be created. An error will be returned if a character device, such as CON: is specified as the file name.
compressionType
A CompressionType enumeration value which specifies the type of compression that was used to create the compressed data file.

Return Value

A boolean value which specifies if the method was successful or not. A return value of True indicates that the method call completed successfully. A return value of False indicates that the method failed and the application should check the value of the LastError property.

See Also

FileEncoder Class | SocketTools Namespace | FileEncoder.ExpandFile Overload List