| .\" zip_file_extra_fields_count.mdoc \-- count extra field for file in zip |
| .\" Copyright (C) 2012 Dieter Baron and Thomas Klausner |
| .\" |
| .\" This file is part of libzip, a library to manipulate ZIP files. |
| .\" The authors can be contacted at <libzip@nih.at> |
| .\" |
| .\" Redistribution and use in source and binary forms, with or without |
| .\" modification, are permitted provided that the following conditions |
| .\" are met: |
| .\" 1. Redistributions of source code must retain the above copyright |
| .\" notice, this list of conditions and the following disclaimer. |
| .\" 2. Redistributions in binary form must reproduce the above copyright |
| .\" notice, this list of conditions and the following disclaimer in |
| .\" the documentation and/or other materials provided with the |
| .\" distribution. |
| .\" 3. The names of the authors may not be used to endorse or promote |
| .\" products derived from this software without specific prior |
| .\" written permission. |
| .\" |
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS |
| .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER |
| .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| .\" |
| .TH ZIP_FILE_EXTRA_FIELDS_COUNT 3 "June 23, 2012" NiH |
| .SH "NAME" |
| zip_file_extra_fields_count , \- .Nm zip_file_extra_fields_count_by_id |
| count extra fields for file in zip |
| .SH "LIBRARY" |
| libzip (-lzip) |
| .SH "SYNOPSIS" |
| #include <zip.h> |
| .PP |
| zip_int16_t |
| zip_file_extra_fields_count(struct zip *archive, zip_uint64_t index); \ |
| "zip_flags_t flags" |
| .PP |
| zip_int16_t |
| zip_file_extra_fields_count_by_id(struct zip *archive, zip_uint64_t index); \ |
| "zip_uint16_t extra_field_id" "zip_flags_t flags" |
| .SH "DESCRIPTION" |
| The |
| zip_file_extra_fields_count |
| function counts the extra fields for the file at position |
| \fBindex\fR |
| in the zip archive. |
| .PP |
| The following flags are supported: |
| .RS |
| .TP 18 |
| \fBZIP_FL_CENTRAL\fR |
| Count only extra fields from the archive's central directory. |
| .TP 18 |
| \fBZIP_FL_LOCAL\fR |
| Count only extra fields from the local file headers. |
| .TP 18 |
| \fBZIP_FL_UNCHANGED\fR |
| Only look at the original unchanged extra fields. |
| .RE |
| .PP |
| The |
| zip_file_extra_fields_count_by_id |
| function counts the extra fields with ID (two-byte signature) |
| \fBextra_field_id\fR |
| The other arguments are the same as for |
| zip_file_extra_fields_count. |
| .SH "RETURN VALUES" |
| Upon successful completion, the requested number of extra fields is returned. |
| Otherwise, \-1 is returned and the error code in |
| \fBarchive\fR |
| is set to indicate the error. |
| .SH "ERRORS" |
| zip_file_extra_fields_count |
| and |
| zip_file_extra_fields_count_by_id |
| fail if: |
| .RS |
| .TP 4 |
| [ZIP_ER_NOENT] |
| \fBindex\fR |
| is not a valid file index in |
| \fBarchive.\fR |
| .\" XXX: _zip_read_local_ef errors |
| .RE |
| .SH "SEE ALSO" |
| libzip(3), |
| zip_file_extra_field_delete(3), |
| zip_file_extra_field_get(3), |
| zip_file_extra_field_set(3) |
| .SH "AUTHORS" |
| |
| Dieter Baron <dillo@giga.or.at> |
| and |
| Thomas Klausner <tk@giga.or.at> |
