archiveList complete with gateways, primitives, test and help
[scilab.git] / scilab / modules / fileio / includes / archive_list.h
1 /*
2 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 * Copyright (C) 2015 - Kartik Gupta
4 *
5 * This file must be used under the terms of the CeCILL.
6 * This source file is licensed as described in the file COPYING, which
7 * you should have received as part of this distribution.  The terms
8 * are also available at
9 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10 *
11 */
12 /*--------------------------------------------------------------------------*/
13 #ifndef __ARCHIVE_LIST_H__
14 #define __ARCHIVE_LIST_H__
15
16 #include "dynlib_fileio.h"
17
18 /**
19 * Returns a list of files in the archive
20 * @param[filename] The absolute or relative path to the archive.
21 * @param[size] The size of the list
22 * @param[error] The error code for error detection
23 * @return returns a pointer to a matrix containing the file names.
24 */
25
26 FILEIO_IMPEXP char** archive_list(char *filename, int *size, int *error);
27
28
29 #endif
30 /*--------------------------------------------------------------------------*/