zip_open(3) [debian man page]

ZIP_OPEN(3)						     Library Functions Manual						       ZIP_OPEN(3)

NAME

       zip_open - open zip archive

LIBRARY

       libzip (-lzip)

SYNOPSIS

       #include <zip.h>

       struct zip * zip_open(const char *path, int flags, int *errorp);

DESCRIPTION

       The zip archive specified by path is opened and a pointer to a

       struct zip, used to manipulate the archive, is returned.  The are specified by or'ing the following values, or 0 for none of them.

	      ZIP_CREATE     Create the archive if it does not exist.

	      ZIP_EXCL	     Error if archive already exists.

	      ZIP_CHECKCONS  Perform additional consistency checks on the archive, and error if they fail.

       If an error occurs and errorp is non-NULL, it will be set to the corresponding error code.

RETURN VALUES

       Upon successful completion zip_open returns a

       struct zip pointer.  Otherwise, NULL is returned and *errorp is set to indicate the error.

ERRORS

       The archive specified by path is opened unless:

	      [ZIP_ER_EXISTS]
		  The file specified by path exists and ZIP_EXCL is set.

	      [ZIP_ER_INCONS]
		  Inconsistencies were found in the file specified by path and ZIP_CHECKCONS was specified.

	      [ZIP_ER_INVAL]
		  The path argument is NULL.

	      [ZIP_ER_MEMORY]
		  Required memory could not be allocated.

	      [ZIP_ER_NOENT]
		  The file specified by path does not exist and ZIP_CREATE is not set.

	      [ZIP_ER_NOZIP]
		  The file specified by path is not a zip archive.

	      [ZIP_ER_OPEN]
		  The file specified by path could not be opened.

	      [ZIP_ER_READ]
		  A read error occurred; see for details.

	      [ZIP_ER_SEEK]
		  The file specified by path does not allow seeks.

SEE ALSO

       libzip(3), zip_close(3), zip_error_to_str(3), zip_fdopen(3)

AUTHORS

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

NiH								 February 15, 2009						       ZIP_OPEN(3)

ZIP_FOPEN(3)						     Library Functions Manual						      ZIP_FOPEN(3)

NAME

       zip_fopen , - .Nm zip_fopen_index open file in zip archive for reading

LIBRARY

       libzip (-lzip)

SYNOPSIS

       #include <zip.h>

       struct zip_file * zip_fopen(struct zip *archive, const char *fname, int flags);

       struct zip_file * zip_fopen_index(struct zip *archive, zip_uint64_t index, int flags);

DESCRIPTION

       The zip_fopen function opens the file name fname in archive.  The flags argument specifies how the name lookup should be done, according to
       the values are described in zip_name_locate(3).	Also, the following values may be or'ed to it.

	      ZIP_FL_COMPRESSED  Read the compressed data.  Otherwise the data is uncompressed by zip_fread.

	      ZIP_FL_UNCHANGED	 Read the original data from the zip archive, ignoring any changes made to the file.

       The zip_fopen_index function opens the file at position index.

       If encrypted data is encountered, the functions call zip_fopen_encrypted(3) or zip_fopen_index_encrypted(3) respectively, using the default
       password set with zip_set_default_password(3).

RETURN VALUES

       Upon successful completion, a

       struct zip_file pointer is returned.  Otherwise, NULL is returned and the error code in archive is set to indicate the error.

ERRORS

	      [ZIP_ER_CHANGED]
		  The file data has been changed.

	      [ZIP_ER_COMPNOTSUPP]
		  The compression method used is not supported.

	      [ZIP_ER_ENCRNOTSUPP]
		  The encryption method used is not supported.

	      [ZIP_ER_MEMORY]
		  Required memory could not be allocated.

	      [ZIP_ER_READ]
		  A file read error occurred.

	      [ZIP_ER_SEEK]
		  A file seek error occurred.

	      [ZIP_ER_ZLIB]
		  Initializing the zlib stream failed.

       The function zip_fopen may also fail and set for any of the errors specified for the routine zip_name_locate(3).

       The function zip_fopen_index may also fail with ZIP_ER_INVAL if index is invalid.

SEE ALSO

       libzip(3), zip_fclose(3), zip_fread(3), zip_get_num_entries(3), zip_name_locate(3), zip_set_default_password(3)

AUTHORS

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

NiH								 February 14, 2011						      ZIP_FOPEN(3)