org.simantics.fmil.core/native/FMILibrary/src/ZIP/include/FMI/fmi_zip_unzip.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_UNZIP_H_
  18 #define FMI_ZIP_UNZIP_H_
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 #include <stdlib.h>
  25 #include <JM/jm_types.h>
  26 #include "miniunz.h"
  27 /**
  28  \file fmi_zip_unzip.h
  29  Declaration of fmi_zip_unzip() function.
  30
  31  \addtogroup fmi_zip Interface to zlib
  32  @{
  33 */
  34
  35 /**\r
  36  * \brief Uncompress a zip file\r
  37  * \r
  38  * @param zip_file_path Full file path of the file to uncompress.\r
  39  * @param output_folder Full file path of the directory where the uncompressed files are put. The folder must already exist. Files with the same name are overwritten.\r
  40  * @param callbacks Callback functions\r
  41  * @return Error status.\r
  42  */
  43 jm_status_enu_t fmi_zip_unzip(const char* zip_file_path, const char* output_folder, jm_callbacks* callbacks);
  44
  45 /** @} */
  46
  47 #ifdef __cplusplus
  48 }
  49 #endif
  50
  51 #endif /* End of header file FMI_ZIP_UNZIP_H_ */