File: ldap-filter.tex

package info (click to toggle)
python-ldap-doc 2.3-1
  • links: PTS
  • area: contrib
  • in suites: lenny
  • size: 200 kB
  • ctags: 121
  • sloc: python: 661; makefile: 44
file content (37 lines) | stat: -rw-r--r-- 1,215 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% $Id: ldap-filter.tex,v 1.2 2007/03/27 22:10:17 stroeder Exp $

\section{\module{ldap.filter} ---
  LDAP filter handling }

\declaremodule{standard}{ldap.filter}

% Author of the module code;
\moduleauthor{Michael Str\"oder}{python-ldap-dev@lists.sourceforge.net}
% Author of the documentation,
\sectionauthor{Michael Str\"oder}{michael@stroeder.com}

\modulesynopsis{LDAP filter handling.}

The \module{ldap.filter} module defines the following functions:

\begin{funcdesc}{escape_filter_chars}{assertion_value} % -> string

This function escapes characters in \var{assertion_value} which
are special in LDAP filters. You should use this function when
building LDAP filter strings from arbitrary input.

\begin{seealso}
\seerfc{4515}{Lightweight Directory Access Protocol (LDAP): String Representation of Search Filters.}{}
\end{seealso}

\end{funcdesc}

\begin{funcdesc}{filter_format}{filter_template, assertion_values} % -> string

This function applies \function{escape_filter_chars()} to each of the strings in
list \var{assertion_values}. After that \var{filter_template} containing
as many \constant{\%s} placeholders as count of assertion values is
used to build the whole filter string.

\end{funcdesc}