FileComment Property

Specifies a comment for the entry in the zip file.

Syntax

ANSI (Cross Platform)
char* GetFileComment(int iFileIndex);
int SetFileComment(int iFileIndex, const char* lpszFileComment); Unicode (Windows) LPWSTR GetFileComment(INT iFileIndex);
INT SetFileComment(INT iFileIndex, LPCWSTR lpszFileComment);
- (NSString*)fileComment:(int)fileIndex;
- (void)setFileComment:(int)fileIndex:(NSString*)newFileComment;
#define PID_ZIP_FILECOMMENT 9

IPWORKSZIP_EXTERNAL void* IPWORKSZIP_CALL IPWorksZip_Zip_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSZIP_EXTERNAL int IPWORKSZIP_CALL IPWorksZip_Zip_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSZIP_EXTERNAL int IPWORKSZIP_CALL IPWorksZip_Zip_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

""

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 FileIndex 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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks ZIP 2020 C++ Edition - Version 20.0 [Build 8300]