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   44335 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

ZIP_FILE_GET_COMMENT(3)	   Library Functions Manual    ZIP_FILE_GET_COMMENT(3)

NAME
       zip_file_get_comment - get comment for file in zip

LIBRARY
       libzip (-lzip)

SYNOPSIS
       zip.h  const  char  *  zip_file_get_comment zip_t *archive zip_uint64_t
       index zip_uint32_t *lenp zip_flags_t flags

DESCRIPTION
       The zip_file_get_comment function returns the comment for the  file  at
       position	 index	in  the	 zip  archive.	 The name is in UTF-8 encoding
       unless ZIP_FL_ENC_RAW was specified (see below).	 This  pointer	should
       not  be	modified  or  free(3)'d,  and  becomes invalid when archive is
       closed.	If lenp is not NULL, the integer to which it  points  will  be
       set to the length of the comment.  If flags is set to ZIP_FL_UNCHANGED,
       the original unchanged comment is returned.

       Additionally, the following flags are supported:

       ZIP_FL_ENC_RAW
	      Return the unmodified comment as it is in the ZIP archive.

       ZIP_FL_ENC_GUESS
	      (Default.)  Guess the encoding of the comment in the ZIP archive
	      and convert it to UTF-8, if necessary.

       ZIP_FL_ENC_STRICT
	      Follow  the  ZIP	specification  for file names and extend it to
	      file comments, expecting them to be encoded in CP-437 in the ZIP
	      archive  (except if it is a UTF-8 comment from the special extra
	      field).  Convert it to UTF-8.  Note: ASCII is a subset  of  both
	      CP-437 and UTF-8.

RETURN VALUES
       Upon  successful	 completion,  a pointer to the comment is returned, or
       NULL if there is no comment.  In case of an error, NULL is returned and
       the error code in archive is set to indicate the error.

ERRORS
       zip_file_get_comment fails if:

       [ZIP_ER_INVAL]	index is not a valid file index in archive.

SEE ALSO
       libzip(3), zip_file_set_comment(3), zip_get_archive_comment(3)

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

NiH			      September 19, 2013       ZIP_FILE_GET_COMMENT(3)

Vote for polarhome