Framework EDI Reference. Methods and Properties
ediFile. EncodeToFile

Encodes the contents of the file to a target file.

Syntax:

• <lRetVal> = object.EncodeToFile(<lEncodingFilter>, <sTargetFile>)

Parameters:

• lEncodingFilter – Encoding mechanism used to encode the contents of the file.  Only the supported mechanisms listed in Encoding Mechanism Type Constants are allowed.
• sTargetFile – Full path name of the target file that will contain the encoded data.

Returns

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

 

Example

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

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

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

' Get file object.
Set oFile = oFileSystem.GetFile(App.Path & "\TestFile.TXT")

oFile.EncodeToFile EncodeType_Base64, App.Path & "\EncodeBase64.TXT"

MsgBox "Done"

Samples

• M_EncodeToFile.zip