ZipComment Property
The comment for the entire zip file.
Syntax
zip.getZipComment([callback]) zip.setZipComment( zipComment, [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 getZipComment([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 setZipComment([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
Specifies a global comment for the zip file. Set this property before invoking Compress to include a comment in the zip file. Read it after invoking Scan to read the zip comment.
Data Type
String