blob: 514062d25d579e6905c0a9ec1c84e464ce3d12c9 [file] [log] [blame]
Dieter Baron9e736f12003-10-03 08:33:09 +00001.\" Converted with mdoc2man 0.2
Thomas Klausner118901b2006-04-23 13:30:30 +00002.\" from NiH: zip_unchange.mdoc,v 1.12 2006/04/23 13:14:46 wiz Exp
3.\" $NiH: zip_unchange.mdoc,v 1.12 2006/04/23 13:14:46 wiz Exp $
Dieter Baron9e736f12003-10-03 08:33:09 +00004.\"
Thomas Klausner201d1b22003-12-27 22:51:30 +00005.\" zip_unchange.mdoc \-- undo changes to file in zip archive
Thomas Klausner118901b2006-04-23 13:30:30 +00006.\" Copyright (C) 2003, 2005, 2006 Dieter Baron and Thomas Klausner
Dieter Baron9e736f12003-10-03 08:33:09 +00007.\"
8.\" This file is part of libzip, a library to manipulate ZIP archives.
9.\" The authors can be contacted at <nih@giga.or.at>
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\" notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\" notice, this list of conditions and the following disclaimer in
18.\" the documentation and/or other materials provided with the
19.\" distribution.
20.\" 3. The names of the authors may not be used to endorse or promote
21.\" products derived from this software without specific prior
22.\" written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
25.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
28.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
30.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
32.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
33.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
34.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35.\"
Thomas Klausner118901b2006-04-23 13:30:30 +000036.TH ZIP_UNCHANGE 3 "April 23, 2006" NiH
Dieter Baron9e736f12003-10-03 08:33:09 +000037.SH "NAME"
38zip_unchange \- undo changes to file in zip archive
39.SH "LIBRARY"
Thomas Klausner201d1b22003-12-27 22:51:30 +000040libzip (-lzip)
Dieter Baron9e736f12003-10-03 08:33:09 +000041.SH "SYNOPSIS"
42.In zip.h
43.Ft int
44.Fn zip_unchange "struct zip *archive" "int index"
45.SH "DESCRIPTION"
46Changes to the file at position
47\fBindex\fR
48are reverted.
49.SH "RETURN VALUES"
50Upon successful completion 0 is returned.
Thomas Klausnerc31f08a2005-01-11 21:23:01 +000051Otherwise, \-1 is returned and the error code in
52\fBarchive\fR
Dieter Baron9e736f12003-10-03 08:33:09 +000053is set to indicate the error.
54.SH "ERRORS"
55.Fn zip_unchange
56fails if:
57.RS
58.TP 4
Thomas Klausnerc31f08a2005-01-11 21:23:01 +000059Bq Er ZIP_ER_EXISTS
60Unchanging the name would result in a duplicate name in the archive.
61.TP 4
Thomas Klausnerd0147e92004-11-17 21:55:17 +000062Bq Er ZIP_ER_INVAL
Dieter Baron9e736f12003-10-03 08:33:09 +000063\fBindex\fR
64is not a valid file index in
65\fBzip.\fR
Dieter Baron9e736f12003-10-03 08:33:09 +000066.RE
67.SH "SEE ALSO"
Thomas Klausner3dd81d82005-06-09 19:01:53 +000068libzip(3),
Thomas Klausner118901b2006-04-23 13:30:30 +000069zip_unchange_all(3),
70zip_unchange_archive(3)
Thomas Klausner75330132005-06-17 12:59:06 +000071.SH "AUTHORS"
72
73Dieter Baron <dillo@giga.or.at>
74and
75Thomas Klausner <tk@giga.or.at>