IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

SourceFile Property

File to be compressed into a self-decrypting archive.

Syntax

 sda.getSourceFile([callback])
 sda.setSourceFile( sourceFile, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSourceFile([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSourceFile([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies the name of a single file to be compressed. When both SourceFile and SourceDirectory are set, only SourceDirectory is used.

Example (Creating a Self-Decrypting Archive)


class.ArchiveFile = "c:\test.exe"
class.RecurseSubdirectories = true
class.SourceDirectory = "c:\foo\"
class.CaptionText = "Testing SDA"
class.BannerText = "Press continue to decompress the archive."
class.CreateSDA()

class.ArchiveFile = "c:\test.exe"
class.SourceFile = "c:\foo\bar.dat"
class.CaptionText = "Testing SDA"
class.BannerText = "Press continue to decompress the archive."
class.CreateSDA()

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Node.js Edition - Version 20.0 [Build 8249]