:DecodeFile() - Opens and decodes an encoded file, storing the contents in the specified file.


Class

     aprEncode()

 

Syntax

     :EncodeFile(cInFile, cOutFile[, nOptions]) --> lSuccess

 

Parameters

 

cInFile

Filename of the File to be Decoded

 

cOutFile

Filename the file that is to contain the Decoded data

 

nOptions

Optional: A bitmask which specifies one or more options. This parameter is constructed by using the bitwise OR operator with any of the following values:

 

*

FILE_ENCODE_BASE64

Default: Use the base64 algorithm for decoding the file. This is the encoding method that is used by most modern e-mail client software. Note that this option cannot be combined with the FILE_ENCODE_UUCODE or FILE_ENCODE_QUOTED option.

FILE_ENCODE_UUCODE

Use the uuencode algorithm for decoding the file. This is a common encoding method used UNIX systems and older e-mail client software. Note that this option cannot be combined with the FILE_ENCODE_BASE64 or FILE_ENCODE_QUOTED option.

FILE_ENCODE_QUOTED

Use the quoted-printable algorithm for decoding the file. Note that this option cannot be combined with the FILE_ENCODE_BASE64 or FILE_ENCODE_UUCODE option.

FILE_ENCODE_COMPRESSED

The encoded file was previously compressed and should be expanded after it has been decoded.

 

* = Default Value

 

Return

     lSuccess. .T. if the file could be Decoded and written to cOutFile. Otherwise .F.

     If the operation failed, look at :nErr and :cErr for more information.

 

Description

     Decodes the contents of the specified file and write the results to an output file (cOutFile).

     

The :DecodeFile() Method decodes files that were previously encoded through a call to the :Encode() Method or by a third-party application such as an e-mail client. The option to expand a previously compressed file requires that the Method be able to create a temporary file on the local system in the directory specified by the TEMP environment variable. This Method can only expand a file that was previously compressed with the :EncodeFile() or the :CompressFile() Method.

 

See Also

 :EncodeFile, :CompressFile, :ExpandFile