e-CryptIt Engine Xojo Plugin - Encodings Xojo Plugin

YEncDecoder.DecodeStart Method

To start to decode a YEnc file use the DecodeStart function.

DecodeStart(
   f as FolderItem,
   destinationDir as FolderItem) as Boolean

Parameters

f
The YEnc file to decode.
destinationDir
The location where to put the decoded file.

Returns

Boolean

Remarks

Returns True if it was successful, false if not. Use the LastError property to determine which error occured.

Possible errors that this function can generate:

  • 0 No Error.
  • -1001 Source file was nil.
  • -1002 Could not open source file.
  • -1601 Destination Dir was nil.
  • -10001 Error looking for start of Yenc header.

    Notes:
    After calling the DecodeStart function then you may want to check the destination file property before calling the DecodeFinish function, to see if you need to change the destination if it exists for example.

    DecodeStart only opens up the source file and looks into it to determine the destination file, the multipart property and part number.

    See Also

    YEncDecoder Class