FileAction Property
The action to apply to the file.
Syntax
archivereader.getFileAction(index, [callback]) archivereader.setFileAction(index, fileAction, [callback])
Possible Values
0 (atAdd), 1 (atKeep), 2 (atUpdate), 3 (atDelete), 4 (atExtract), 5 (atSkip)
Default Value
0
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 getFileAction([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 setFileAction([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
The action to apply to the file.
Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:
atAdd (0) | Add the file to the archive |
atKeep (1) | Keep the existing file in the archive |
atUpdate (2) | Update the archived file with a fresher copy |
atDelete (3) | Delete the file from the archive |
atExtract (4) | Extract the file (extraction only) |
atSkip (5) | Skip file extraction (extraction only) |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.
This property is not available at design time.
Data Type
Integer