zip_get_file_comment(3)

1ZIP_GET_FILE_COMMENT(3)    Library Functions Manual    ZIP_GET_FILE_COMMENT(3)
2
3
4

NAME

6       zip_get_file_comment - get comment for file in zip
7

LIBRARY

9       libzip (-lzip)
10

SYNOPSIS

12       #include <zip.h>
13
14       const  char  * zip_get_file_comment(struct zip *archive, int index, int
15       *lenp, int flags);
16

DESCRIPTION

18       The zip_get_file_comment function returns the comment for the  file  at
19       position index in the zip archive.  This pointer should not be modified
20       or free(3) Ap d.  If lenp is not NULL, the integer to which  it  points
21       will  be  set  to  the  length  of  the  comment.   If  flags is set to
22       ZIP_FL_UNCHANGED, the original unchanged comment is returned.
23

RETURN VALUES

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

ERRORS

30       zip_get_file_comment fails if:
31
32              [ZIP_ER_INVAL]
33                  index is not a valid file index in archive.
34

AUTHORS

39       Dieter Baron <dillo@giga.or.at> and Thomas Klausner <tk@giga.or.at>
40
41
42
43NiH                             April 23, 2006         ZIP_GET_FILE_COMMENT(3)