| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 1 | .TH "ZIP_FILE_RENAME" "3" "June 23, 2012" "NiH" "Library Functions Manual" |
| 2 | .nh |
| 3 | .if n .ad l |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 4 | .SH "NAME" |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 5 | \fBzip_file_rename\fR |
| 6 | \- rename file in zip archive |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 7 | .SH "LIBRARY" |
| 8 | libzip (-lzip) |
| 9 | .SH "SYNOPSIS" |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 10 | \fB#include <zip.h>\fR |
| 11 | .sp |
| 12 | \fIint\fR |
| Thomas Klausner | 193739d | 2014-10-08 12:37:24 +0200 | [diff] [blame] | 13 | .PD 0 |
| 14 | .HP 4n |
| 15 | \fBzip_file_rename\fR(\fIzip_t\ *archive\fR, \fIzip_uint64_t\ index\fR, \fIconst\ char\ *name\fR, \fIzip_flags_t\ flags\fR); |
| 16 | .PD |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 17 | .SH "DESCRIPTION" |
| 18 | The file at position |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 19 | \fIindex\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 20 | in the zip archive |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 21 | \fIarchive\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 22 | is renamed to |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 23 | \fIname\fR. |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 24 | The |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 25 | \fIflags\fR |
| Thomas Klausner | 28e18e2 | 2012-06-24 01:13:23 +0200 | [diff] [blame] | 26 | argument can be any of: |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 27 | .TP 22n |
| 28 | \fRZIP_FL_ENC_GUESS\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 29 | Guess encoding of |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 30 | \fIname\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 31 | (default). |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 32 | .TP 22n |
| 33 | \fRZIP_FL_ENC_UTF_8\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 34 | Interpret |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 35 | \fIname\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 36 | as UTF-8. |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 37 | .TP 22n |
| 38 | \fRZIP_FL_ENC_CP437\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 39 | Interpret |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 40 | \fIname\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 41 | as code page 437 (CP-437). |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 42 | .SH "RETURN VALUES" |
| 43 | Upon successful completion 0 is returned. |
| 44 | Otherwise, \-1 is returned and the error code in |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 45 | \fIarchive\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 46 | is set to indicate the error. |
| 47 | .SH "ERRORS" |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 48 | \fBzip_rename\fR() |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 49 | fails if: |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 50 | .TP 19n |
| 51 | [\fRZIP_ER_DELETED\fR] |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 52 | The file to be renamed has been deleted from the archive. |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 53 | .TP 19n |
| 54 | [\fRZIP_ER_EXISTS\fR] |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 55 | There is already a file called |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 56 | \fIname\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 57 | in the archive. |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 58 | .TP 19n |
| 59 | [\fRZIP_ER_INVAL\fR] |
| 60 | \fIindex\fR |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 61 | is not a valid file index in |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 62 | \fIarchive\fR, |
| 63 | \fIname is\fR |
| 64 | \fRNULL\fR, |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 65 | the empty string, or not a valid UTF-8 encoded string. |
| 66 | Also a file cannot be renamed to a directory or vice versa. |
| 67 | Directories are denoted by a trailing slash. |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 68 | .SH "SEE ALSO" |
| 69 | libzip(3), |
| 70 | zip_unchange(3) |
| 71 | .SH "AUTHORS" |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 72 | Dieter Baron <\fIdillo@nih.at\fR> |
| Thomas Klausner | 20a4713 | 2012-06-23 23:37:37 +0200 | [diff] [blame] | 73 | and |
| Thomas Klausner | a5e9d4d | 2013-10-05 16:57:58 +0200 | [diff] [blame] | 74 | Thomas Klausner <\fItk@giga.or.at\fR> |
