FileComment Property

Specifies a comment for the entry in the zip file.

Syntax

 zip.getFileComment(index, [callback])
 zip.setFileComment(index,  fileComment, [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 getFileComment([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 setFileComment([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 comment for the entry in the zip file. Before compression, set This property to include comments in this zip file. After an archive has been scanned, This property will contain any comments the zip file contains.

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