← Back to branch summary

~ubuntu-branches/ubuntu/hardy/exim4/hardy-proposed

« back to all changes in this revision

Viewing changes to src/lookups/README

  • Committer: Bazaar Package Importer
  • Author(s): Marc Haber
  • Date: 2005-07-02 06:08:34 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050702060834-qk17pd52kb9nt3bj
Tags: 4.52-1
http://bugs.debian.org/315775
* new upstream version 4.51. (mh)
  * adapt 70_remove_exim-users_references
  * remove 37_gnutlsparams
  * adapt 36_pcre
  * adapt 31_eximmanpage
* fix package priorities to have them in sync with override again. (mh)
* Fix error in nb (Norwegian) translation.
  Thanks to Helge Hafting. (mh). Closes: #315775
* Standards-Version: 3.6.2, no changes needed. (mh)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/lookups/README
 
1
$Cambridge: exim/exim-src/src/lookups/README,v 1.1 2004/10/07 13:10:01 ph10 Exp $
 
2
 
1
3
LOOKUPS
2
4
-------
3
5
 
44
46
by search_tidyup() after all cached handles have been closed via the
45
47
xxx_close() function.
46
48
 
 
49
The lookup functions are wrapped into a special store pool (POOL_SEARCH). You
 
50
can safely use store_get to allocate store for your handle caching. The store
 
51
will be reset after all xxx_tidy() functions are called.
 
52
 
47
53
The function interfaces are as follows:
48
54
 
49
55
 
110
116
  uschar **errmsg     where to put an error message on failure;
111
117
                      this is initially set to "", and should be left
112
118
                      as that for a standard "entry not found" error
 
119
  BOOL *do_cache      the lookup should set this to FALSE when it changes data.
 
120
                      This is TRUE by default. When set to FALSE the cache tree
 
121
                      of the current search handle will be cleaned and the
 
122
                      current result will NOT be cached. Currently the mysql
 
123
                      and pgsql lookups use this when UPDATE/INSERT queries are
 
124
                      executed.
113
125
 
114
126
Even though the key is zero-terminated, the length is passed because in the
115
127
common case it has been computed already and is often needed.
137
149
${quote_xxx:<string>}, if it exists. If not, the expansion code makes no change
138
150
to the string. The function must apply any quoting rules that are specific to
139
151
the lookup, and return a pointer to the revised string. If quoting is not
140
 
needed, it can return its single argument, which is a char *.
 
152
needed, it can return its single argument, which is a uschar *. This function
 
153
does NOT use the POOL_SEARCH store, because it's usually never called from any
 
154
lookup code.
141
155
 
142
156
****