summaryrefslogtreecommitdiff
path: root/modules/fileio/includes/mgetl.h
blob: aae9f8546a208e81eea58be44ae2119fd57a2cf1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/*
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2010 - DIGITEO - Allan CORNET
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution.  The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
*/
/*--------------------------------------------------------------------------*/
#ifndef __MGETL_H__
#define __MGETL_H__

#include "dynlib_fileio.h"
#include "charEncoding.h"

typedef enum
{
    MGETL_NO_ERROR = 0,
    MGETL_EOF = 1,
    MGETL_MEMORY_ALLOCATION_ERROR = 2,
    MGETL_ERROR = 3
} mgetlError;

/* file descriptor id for stdin */
#define STDIN_ID 5
/* file descriptor id for stdout */
#define STDOUT_ID 6

/**
 * @fn  char ** mgetl(int fd, int nbLinesIn, int *nbLinesOut, int *ierr) #endif
 *
 * @brief   read lines of a file.
 *
 * @author  Allan Cornet
 * @date    4/16/2010
 *
 * @param   fd                  The file descriptor id.
 * @param   nbLinesIn           The nb lines in .
 * @param [in,out]  nbLinesOut  If non-null, the nb lines out.
 * @param [in,out]  ierr        If non-null, the ierr.
 *
 * @return  null if it fails, else strings readed.
**/
FILEIO_IMPEXP char ** mgetl(int fd, int nbLinesIn, int *nbLinesOut, int *ierr);

#endif /* __MGETL_H__ */
/*--------------------------------------------------------------------------*/