Google Git
Sign in
flutter / third_party / libzip / 3e00f024299d02ca302e3de56bab625940abd6dd / . / man / zip_close.man
blob: d553754747728d36446286d49ad9f24f774c431c [file] [log] [blame]
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]1.TH "ZIP_CLOSE" "3" "February 13, 2012" "NiH" "Library Functions Manual"
2.nh
3.if n .ad l
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]4.SH "NAME"
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]5\fBzip_close\fR
6\- close zip archive
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]7.SH "LIBRARY"
Thomas Klausner201d1b22003-12-27 22:51:30 +0000[diff] [blame]8libzip (-lzip)
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]9.SH "SYNOPSIS"
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]10\fB#include <zip.h>\fR
11.sp
12\fIint\fR
Thomas Klausner193739d2014-10-08 12:37:24 +0200[diff] [blame]13.PD 0
14.HP 4n
15\fBzip_close\fR(\fIzip_t\ *archive\fR);
16.PD
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]17.SH "DESCRIPTION"
18The
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]19\fBzip_close\fR()
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]20function closes
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]21\fIarchive\fR
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]22and frees the memory allocated for it.
Dieter Baron9e736f12003-10-03 08:33:09 +0000[diff] [blame]23If any files within were changed, those changes are written to disk
24first.
25If writing changes fails,
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]26\fBzip_close\fR()
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]27fails and
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]28\fIarchive\fR
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]29is left unchanged.
Thomas Klausnera10bd6c2008-07-25 11:54:24 +0200[diff] [blame]30If
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]31\fIarchive\fR
Thomas Klausnera10bd6c2008-07-25 11:54:24 +0200[diff] [blame]32contains no files, the file is completely removed (no empty archive is
33written).
Thomas Klausnerdd4cf742012-02-13 22:15:37 +0100[diff] [blame]34.PP
35To close a zip file without saving changes, use
36zip_discard(3).
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]37.SH "RETURN VALUES"
Dieter Baron9e736f12003-10-03 08:33:09 +0000[diff] [blame]38Upon successful completion 0 is returned.
Thomas Klausnerc31f08a2005-01-11 21:23:01 +0000[diff] [blame]39Otherwise, \-1 is returned and the error code in
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]40\fIarchive\fR
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]41is set to indicate the error.
42.SH "ERRORS"
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]43\fBzip_close\fR()
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]44will fail if:
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]45.TP 19n
46[\fRZIP_ER_EOF\fR]
Thomas Klausnere8b26942005-06-09 19:52:49 +0000[diff] [blame]47Unexpected end-of-file found while reading from a file.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]48.TP 19n
49[\fRZIP_ER_INTERNAL\fR]
Thomas Klausnere8b26942005-06-09 19:52:49 +0000[diff] [blame]50The callback function of an added or replaced file returned an
51error but failed to report which.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]52.TP 19n
53[\fRZIP_ER_INVAL\fR]
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]54The
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]55\fIpath\fR
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]56argument is
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]57\fRNULL\fR.
58.TP 19n
59[\fRZIP_ER_MEMORY\fR]
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]60Required memory could not be allocated.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]61.TP 19n
62[\fRZIP_ER_NOZIP\fR]
Thomas Klausnerc31f08a2005-01-11 21:23:01 +0000[diff] [blame]63File is not a zip archive.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]64.TP 19n
65[\fRZIP_ER_READ\fR]
Thomas Klausnerc31f08a2005-01-11 21:23:01 +0000[diff] [blame]66A file read failed.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]67.TP 19n
68[\fRZIP_ER_RENAME\fR]
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]69A temporary file could not be renamed to its final name.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]70.TP 19n
71[\fRZIP_ER_SEEK\fR]
Thomas Klausnerc31f08a2005-01-11 21:23:01 +0000[diff] [blame]72A file seek failed.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]73.TP 19n
74[\fRZIP_ER_TMPOPEN\fR]
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]75A temporary file could not be created.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]76.TP 19n
77[\fRZIP_ER_WRITE\fR]
Thomas Klausnerc31f08a2005-01-11 21:23:01 +0000[diff] [blame]78A file write failed.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]79.TP 19n
80[\fRZIP_ER_ZLIB\fR]
Thomas Klausnere8b26942005-06-09 19:52:49 +0000[diff] [blame]81An error occurred while (de)compressing a stream with
82zlib(3).
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]83.PD 0
84.PP
Thomas Klausnere8b26942005-06-09 19:52:49 +0000[diff] [blame]85Additionally, any errors returned by the callback function
86for added or replaced files will be passed back.
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]87.PD
Dieter Baron52bcc842003-10-03 07:59:27 +0000[diff] [blame]88.SH "SEE ALSO"
Thomas Klausner3dd81d82005-06-09 19:01:53 +0000[diff] [blame]89libzip(3),
Thomas Klausnerdd4cf742012-02-13 22:15:37 +0100[diff] [blame]90zip_discard(3),
Thomas Klausnerc31f08a2005-01-11 21:23:01 +0000[diff] [blame]91zip_error_get(3),
Thomas Klausner4b123342011-01-03 19:36:33 +0100[diff] [blame]92zip_fdopen(3),
Thomas Klausnerc31f08a2005-01-11 21:23:01 +0000[diff] [blame]93zip_open(3),
94zip_strerror(3)
Thomas Klausner75330132005-06-17 12:59:06 +0000[diff] [blame]95.SH "AUTHORS"
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]96Dieter Baron <\fIdillo@nih.at\fR>
Thomas Klausner75330132005-06-17 12:59:06 +0000[diff] [blame]97and
Thomas Klausnera5e9d4d2013-10-05 16:57:58 +0200[diff] [blame]98Thomas Klausner <\fItk@giga.or.at\fR>