2 * include/fstreams.h - type representing a vector of file streams.
\r
4 * Copyright 2008,2009 Martin Quinson, Malek Cherier All right reserved.
\r
6 * This program is free software; you can redistribute it and/or modify it
\r
7 * under the terms of the license (GNU LGPL) which comes with this package.
\r
10 * This file contains all the declarations of the functions related with
\r
11 * the tesh fstreams type.
\r
14 #ifndef __FSTREAMS_H
\r
15 #define __FSTREAMS_H
\r
23 /*! \brief fstreams_new - create a new fstreams.
\r
25 * \param directory The directory of the tesh file.
\r
26 * \param name The name of the tesh file.
\r
28 * \return If successful the function returns the newly created
\r
29 * unit. Otherwise the function returns NULL and sets the
\r
30 * global variable errno with the appropiate error code.
\r
32 * If the parameter directory is NULL, the parameter name
\r
36 * [EINVAL] if one of the parameters is invalid.
\r
37 * [ENOMEM] if the system has not enough space to allocate
\r
41 fstreams_new(void_f_pvoid_t fn_finalize);
\r
44 fstreams_exclude(fstreams_t fstreams, excludes_t excludes);
\r
47 fstreams_contains(fstreams_t fstreams, fstream_t fstream);
\r
50 fstreams_add(fstreams_t fstreams, fstream_t fstream);
\r
53 fstreams_free(void** fstreamsptr);
\r
56 fstreams_get_size(fstreams_t fstreams);
\r
59 fstreams_is_empty(fstreams_t fstreams);
\r
62 fstreams_contains(fstreams_t fstreams, fstream_t fstream);
\r
65 fstreams_load(fstreams_t fstreams);
\r
74 #endif /* !__FSTREAMS_H */
\r