Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   25941 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

ZIP_FILE_SET_COMMENT(3)				       ZIP_FILE_SET_COMMENT(3)

NAME
       zip_file_set_comment - set comment for file in zip

LIBRARY
       libzip (-lzip)

SYNOPSIS
       #include <zip.h>

       int  zip_set_file_comment(struct	 zip  *archive,	 zip_uint64_t  index);
       "const char *comment" "zip_uint16_t len" "zip_flags_t flags"

DESCRIPTION
       The zip_file_set_comment function sets the  comment  for	 the  file  at
       position index in the zip archive to comment of length len.  If comment
       is NULL and len is 0, the file comment  will  be	 removed.   The	 flags
       argument can be any of:

	      ZIP_FL_ENC_GUESS	    Guess encoding of comment (default).

	      ZIP_FL_ENC_UTF_8	    Interpret comment as UTF-8.

	      ZIP_FL_ENC_CP437	    Interpret	comment	  as   code  page  437
				    (CP-437).

RETURN VALUES
       Upon successful completion 0 is returned.  Otherwise,  -1  is  returned
       and the error information in archive is set to indicate the error.

ERRORS
       zip_file_set_comment fails if:

	      [ZIP_ER_INVAL]
		  index	 is  not a valid file index in archive, or len is less
		  than 0 or longer than the maximum comment length  in	a  zip
		  file	(65535),  or  comment  is  not	a  valid UTF-8 encoded
		  string.

	      [ZIP_ER_MEMORY]
		  Required memory could not be allocated.

SEE ALSO
       libzip(3),     zip_get_archive_comment(3),     zip_file_get_comment(3),
       zip_set_archive_comment(3)

AUTHORS
       Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>

NiH				 June 23, 2012	       ZIP_FILE_SET_COMMENT(3)

Vote for polarhome