org.simantics.fmil.core/native/FMILibrary/src/ZIP/include/FMI/fmi_zip_zip.h

   1 /*
   2     Copyright (C) 2012 Modelon AB
   3
   4     This program is free software: you can redistribute it and/or modify
   5     it under the terms of the BSD style license.
   6
   7      This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10     FMILIB_License.txt file for more details.
  11
  12     You should have received a copy of the FMILIB_License.txt file
  13     along with this program. If not, contact Modelon AB <http://www.modelon.com>.
  14 */
  15
  16
  17 #ifndef FMI_ZIP_ZIP_H_
  18 #define FMI_ZIP_ZIP_H_
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 #include <JM/jm_types.h>
  25 /**
  26  \file fmi_zip_unzip.h
  27  Declaration of fmi_zip_zip() function.
  28
  29  \addtogroup fmi_zip Interface to zlib
  30  \brief Interface to Zlib library <http://www.zlib.net/> and Minizip <http://www.winimage.com/zLibDll/minizip.html>
  31         to support zip and unzip of FMU modules.
  32  @{
  33 */
  34
  35 /**\r
  36  * \brief Compress files to the zip format\r
  37  * \r
  38  * @param zip_file_path Full file path to the final compressed file. The folders must exist.\r
  39  * @param n_files_to_zip Number of files to compress\r
  40  * @param files_to_zip List of the full file names to compress\r
  41  * @param callbacks Callback functions\r
  42  * @return Error status.\r
  43  */
  44 jm_status_enu_t fmi_zip_zip(const char* zip_file_path, int n_files_to_zip, const char** files_to_zip, jm_callbacks* callbacks);
  45
  46 /** @} */
  47
  48 #ifdef __cplusplus
  49 }
  50 #endif
  51
  52 #endif /* End of header file FMI_ZIP_ZIP_H_ */
  53