FileLocalPath Property
The local path associated with this entry.
Syntax
archivereader.getFileLocalPath(index, [callback]) archivereader.setFileLocalPath(index, fileLocalPath, [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 getFileLocalPath([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 setFileLocalPath([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 local path associated with this entry. It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.
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
String