Xceed Zip Compression Library Documentation
ZipComment event
Xceed Zip control reference > Xceed Zip control events > ZipComment event

Description

The ZipComment event is triggered to provide a "zip comment" - a string or data block that can be up to 64K of uncompressed data. The zip comment is usually useful for providing a short comment about the entire zip file.

When zipping, the sComment parameter provided by this event can be modified in order to change or add a zip file comment.

The Zip Specification only allows the global zip comment to be stored in ANSI characters in the zip file. As such, the zip comment is automatically converted to an ANSI string when written to the zip file. When it is read from the file, it is read as an ANSI string, then converted to a wide character string to fit the control's API.

Declaration (DLL API)  

Event ZipComment(sComment As String)
Declaration (DLL API)  
xcdZipCommentParams * pParams = ( xcdZipCommentParams * ) lParam;

Parameters

Parameter Modifiable Description
sComment YES The zip file's comment (modifiable when running the Zip method)

Applicable methods

Zip, Unzip or ListZipContents