db2697b01f201b5bb69fcc19fa9d3652209e4cbd
[platform/upstream/libzip.git] / man / zip_unchange.man
1 .TH "ZIP_UNCHANGE" "3" "April 23, 2006" "NiH" "Library Functions Manual"
2 .nh
3 .if n .ad l
4 .SH "NAME"
5 \fBzip_unchange\fR
6 \- undo changes to file in zip archive
7 .SH "LIBRARY"
8 libzip (-lzip)
9 .SH "SYNOPSIS"
10 \fB#include <zip.h>\fR
11 .sp
12 \fIint\fR
13 .PD 0
14 .HP 4n
15 \fBzip_unchange\fR(\fIzip_t\ *archive\fR, \fIint\ index\fR);
16 .PD
17 .SH "DESCRIPTION"
18 Changes to the file at position
19 \fIindex\fR
20 are reverted.
21 .SH "RETURN VALUES"
22 Upon successful completion 0 is returned.
23 Otherwise, \-1 is returned and the error code in
24 \fIarchive\fR
25 is set to indicate the error.
26 .SH "ERRORS"
27 \fBzip_unchange\fR()
28 fails if:
29 .TP 19n
30 [\fRZIP_ER_EXISTS\fR]
31 Unchanging the name would result in a duplicate name in the archive.
32 .TP 19n
33 [\fRZIP_ER_INVAL\fR]
34 \fIindex\fR
35 is not a valid file index in
36 \fIzip\fR.
37 .SH "SEE ALSO"
38 libzip(3),
39 zip_unchange_all(3),
40 zip_unchange_archive(3)
41 .SH "AUTHORS"
42 Dieter Baron <\fIdillo@nih.at\fR>
43 and
44 Thomas Klausner <\fItk@giga.or.at\fR>