Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

zip_file_extra_fields_count (3)

Name

zip_file_extra_fields_count - count extra fields for file in zip

Synopsis

#include <zip.h>

zip_int16_t
zip_file_extra_fields_count(zip_t *archive, zip_uint64_t index,
zip_flags_t flags);

zip_int16_t
zip_file_extra_fields_count_by_id(zip_t *archive, zip_uint64_t index,
zip_uint16_t extra_field_id, zip_flags_t flags);

Description

ZIP_FILE_EXTRA_FIELDS... BSD Library Functions Manual ZIP_FILE_EXTRA_FIELDS...

NAME
     zip_file_extra_fields_count, zip_file_extra_fields_count_by_id -- count
     extra fields for file in zip

LIBRARY
     libzip (-lzip)

SYNOPSIS
     #include <zip.h>

     zip_int16_t
     zip_file_extra_fields_count(zip_t *archive, zip_uint64_t index,
         zip_flags_t flags);

     zip_int16_t
     zip_file_extra_fields_count_by_id(zip_t *archive, zip_uint64_t index,
         zip_uint16_t extra_field_id, zip_flags_t flags);

DESCRIPTION
     The zip_file_extra_fields_count() function counts the extra fields for
     the file at position index in the zip archive.

     The following flags are supported:

           ZIP_FL_CENTRAL    Count extra fields from the archive's central
                             directory.

           ZIP_FL_LOCAL      Count extra fields from the local file headers.

           ZIP_FL_UNCHANGED  Count the original unchanged extra fields, ignor-
                             ing any changes made.

     The zip_file_extra_fields_count_by_id() function counts the extra fields
     with ID (two-byte signature) extra_field_id.  The other arguments are the
     same as for zip_file_extra_fields_count().

     Extra fields that are the same in the central directory and the local
     file header are merged into one.  Therefore, the counts with
     ZIP_FL_CENTRAL and ZIP_FL_LOCAL do not need to add up to the same value
     as when given ZIP_FL_CENTRAL|ZIP_FL_LOCAL at the same time.

RETURN VALUES
     Upon successful completion, the requested number of extra fields is
     returned.  Otherwise, -1 is returned and the error code in archive is set
     to indicate the error.

ERRORS
     zip_file_extra_fields_count() and zip_file_extra_fields_count_by_id()
     fail if:

     [ZIP_ER_NOENT]     index is not a valid file index in archive.


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | compress/libzip  |
     +---------------+------------------+
     |Stability      | Volatile         |
     +---------------+------------------+

SEE ALSO
     libzip(3), zip_file_extra_field_delete(3), zip_file_extra_field_get(3),
     zip_file_extra_field_set(3)

HISTORY
     zip_file_extra_fields_count() and zip_file_extra_fields_count_by_id()
     were added in libzip 0.11.

AUTHORS
     Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>



NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://libzip.org/download/libzip-1.7.3.tar.gz.

     Further information about this software can be found on the open source
     community website at https://libzip.org/.

BSD                            December 18, 2017                           BSD