[thirdparty/sarg.git] / documentation / exclude.txt

/*! \file exclude.c
\brief Handle exclusion of sites and users from the report.
*/


/*! \fn int vhexclude(const char *excludefile, const char *url)
Tell if the site accessed by the user is excluded from the report.

\param excludefile The list of the excluded sites as loaded by gethexclude().
\param url The URL to check.

\retval 1 The site is not excluded.
\retval 0 The site is excluded.
*/


/*! \fn int vuexclude(const char *excludeuser, const char *user)
Tell if the user is excluded from the report.

\param excludeuser The list of the excluded users as loaded by getuexclude().
\param user The user to check.

\retval 1 The user is not excluded.
\retval 0 The user is excluded.
*/
Commit	Line	Data
2357ef77 FM	1	/*! \file exclude.c
	2	\brief Handle exclusion of sites and users from the report.
	3	*/
	4
	5
	6
	7
	8
	9	/! \fn int vhexclude(const char excludefile, const char *url)
	10	Tell if the site accessed by the user is excluded from the report.
	11
	12	\param excludefile The list of the excluded sites as loaded by gethexclude().
	13	\param url The URL to check.
	14
	15	\retval 1 The site is not excluded.
	16	\retval 0 The site is excluded.
	17	*/
	18
	19
	20
	21
	22
	23	/! \fn int vuexclude(const char excludeuser, const char *user)
	24	Tell if the user is excluded from the report.
	25
	26	\param excludeuser The list of the excluded users as loaded by getuexclude().
	27	\param user The user to check.
	28
	29	\retval 1 The user is not excluded.
	30	\retval 0 The user is excluded.
	31	*/