path: root/funcs/func_strings.c
diff options
authortilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2007-10-15 17:51:05 +0000
committertilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2007-10-15 17:51:05 +0000
commit941606972a48939ef62c73fde3a4a0d27b051881 (patch)
treeba1641f828053984f7d33adf1bae763c241f58ce /funcs/func_strings.c
parent37aa78847e050d636cfd39e6e418610e421cb778 (diff)
Document my changes from Friday
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@85633 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'funcs/func_strings.c')
1 files changed, 7 insertions, 0 deletions
diff --git a/funcs/func_strings.c b/funcs/func_strings.c
index a648c6cda..d8327b5ce 100644
--- a/funcs/func_strings.c
+++ b/funcs/func_strings.c
@@ -223,6 +223,13 @@ static struct ast_custom_function filter_function = {
.synopsis = "Filter the string to include only the allowed characters",
.syntax = "FILTER(<allowed-chars>,<string>)",
.read = filter,
+ .desc =
+"Permits all characters listed in <allowed-chars>, filtering all others out.\n"
+"In addition to literally listing the characters, you may also use ranges of\n"
+"characters (delimited by a '-'), as well as hexadecimal characters started\n"
+"with a \\x (i.e. \\x20) and octal characters started with \\0 (i.e. \\040).\n"
+"Also, \\t, \\n, and \\r are recognized. If you want a literal '-' character,\n"
+"simply prefix it with a '\\'\n",
static int regex(struct ast_channel *chan, const char *cmd, char *parse, char *buf,