RecurseSubdirectories Property

Whether or not to recurse into subdirectories during archive creation.

Syntax

 sda.getRecurseSubdirectories([callback])
 sda.setRecurseSubdirectories( recurseSubdirectories, [callback])

Default Value

TRUE

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 getRecurseSubdirectories([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 setRecurseSubdirectories([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

If this property is set to true, when calling CreateSDA the class will recurse into all the subdirectories under SourceDirectory and include them in the self extracting archive. If this property is false, only the files in SourceDirectory will be included in the archive.

Data Type

Boolean