doc
csync_exclude.h
Go to the documentation of this file.
1 /*
2  * libcsync -- a library to sync a directory with another
3  *
4  * Copyright (c) 2008-2013 by Andreas Schneider <asn@cryptomilk.org>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #ifndef _CSYNC_EXCLUDE_H
22 #define _CSYNC_EXCLUDE_H
23 
24 /**
25  * @brief Load exclude list
26  *
27  * @param ctx The context of the synchronizer.
28  * @param fname The filename to load.
29  *
30  * @return 0 on success, -1 if an error occured with errno set.
31  */
32 int csync_exclude_load(CSYNC *ctx, const char *fname);
33 
34 /**
35  * @brief Destroy the exclude list in memory.
36  *
37  * @param ctx The synchronizer context.
38  */
39 void csync_exclude_destroy(CSYNC *ctx);
40 
41 /**
42  * @brief Check if the given path should be excluded.
43  *
44  * This excludes also paths which can't be used without unix extensions.
45  *
46  * @param ctx The synchronizer context.
47  * @param path The patch to check.
48  *
49  * @return 1 if excluded, 0 if not.
50  */
51 int csync_excluded(CSYNC *ctx, const char *path);
52 
53 #endif /* _CSYNC_EXCLUDE_H */
54 
55 /* vim: set ft=c.doxygen ts=8 sw=2 et cindent: */
csync public structure
Definition: csync_private.h:89
void csync_exclude_destroy(CSYNC *ctx)
Destroy the exclude list in memory.
char path[1]
Definition: csync_private.h:44
int csync_excluded(CSYNC *ctx, const char *path)
Check if the given path should be excluded.
int csync_exclude_load(CSYNC *ctx, const char *fname)
Load exclude list.