X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/c988f1f4faa9f679f79beddf3c14676c5dcb8e28..d7d7b7b91dd75cec636fc144da7e27eed860f971:/src/src/local_scan.h

diff --git a/src/src/local_scan.h b/src/src/local_scan.h
index e612ccd84..978647847 100644
--- a/src/src/local_scan.h
+++ b/src/src/local_scan.h
@@ -1,20 +1,24 @@
-/* $Cambridge: exim/src/src/local_scan.h,v 1.3 2005/01/04 10:00:42 ph10 Exp $ */
+/* $Cambridge: exim/src/src/local_scan.h,v 1.6 2006/02/07 11:19:00 ph10 Exp $ */
 
 /*************************************************
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 
-/* Copyright (c) University of Cambridge 1995 - 2005 */
+/* Copyright (c) University of Cambridge 1995 - 2006 */
 /* See the file NOTICE for conditions of use and distribution. */
 
 /* This file is the header that is the only Exim header to be included in the
 source for the local_scan.c() function. It contains definitions that are made
-available for use in that function, and which are documented. */
+available for use in that function, and which are documented.
 
+This API is also used for functions called by the ${dlfunc expansion item. */
 
-/* Some basic types that make some things easier, and the store functions. */
+
+/* Some basic types that make some things easier, the Exim configuration
+settings, and the store functions. */
 
 #include <sys/types.h>
+#include "config.h"
 #include "mytypes.h"
 #include "store.h"
 
@@ -34,13 +38,27 @@ enum {
 };
 
 
-/* Return codes from the support functions lss_match_xxx(). */
+/* Functions called by ${dlfunc{file}{func}{arg}...} return one of the five
+status codes defined immediately below. The function's first argument is either
+the result of expansion, or the error message in case of failure. The second
+and third arguments are standard argument count and vector, comprising the
+{arg} values specified in the expansion item. */
+
+typedef int exim_dlfunc_t(uschar **yield, int argc, uschar *argv[]);
+
+
+/* Return codes from the support functions lss_match_xxx(). These are also the
+codes that dynamically-loaded ${dlfunc functions must return. */
 
 #define  OK            0          /* Successful match */
 #define  DEFER         1          /* Defer - some problem */
 #define  FAIL          2          /* Matching failed */
 #define  ERROR         3          /* Internal or config error */
 
+/* Extra return code for ${dlfunc functions */
+
+#define  FAIL_FORCED   4          /* "Forced" failure */
+
 
 /* Available logging destinations */