Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

zip_dir_add (3)

Name

zip_dir_add - add directory to zip archive

Synopsis

#include <zip.h>

zip_int64_t
zip_dir_add(zip_t *archive, const char *name, zip_flags_t flags);

Description

ZIP_DIR_ADD(3)           BSD Library Functions Manual           ZIP_DIR_ADD(3)

NAME
     zip_dir_add -- add directory to zip archive

LIBRARY
     libzip (-lzip)

SYNOPSIS
     #include <zip.h>

     zip_int64_t
     zip_dir_add(zip_t *archive, const char *name, zip_flags_t flags);

DESCRIPTION
     The function zip_dir_add() adds a directory to a zip archive.  The argu-
     ment archive specifies the zip archive to which the directory should be
     added.  name is the directory's name in the zip archive.

     This function adds an entry to the archive.  It does not check whether a
     directory with that name exists in the file system, nor does it add its
     contents if it does.  The flags argument can be any of:

     ZIP_FL_ENC_GUESS      Guess encoding of name (default).

     ZIP_FL_ENC_UTF_8      Interpret name as UTF-8.

     ZIP_FL_ENC_CP437      Interpret name as code page 437 (CP-437).

RETURN VALUES
     Upon successful completion, the index of the new entry in the archive is
     returned.  Otherwise, -1 is returned and the error code in archive is set
     to indicate the error.

ERRORS
     zip_dir_add() fails if:

     [ZIP_ER_EXISTS]    There is already an entry called name in the archive.

     [ZIP_ER_INVAL]     archive or name are NULL, or invalid UTF-8 encoded
                        file names.

     [ZIP_ER_MEMORY]    Required memory could not be allocated.


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_add(3)

HISTORY
     zip_dir_add() was 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                             April 25, 2020                             BSD