clean up some application descriptions to use more gooder English
[asterisk/asterisk.git] / apps / app_cdr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Martin Pycko <martinp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Applications connected with CDR engine
21  *
22  * \ingroup applications
23  */
24
25 #include <sys/types.h>
26 #include <stdlib.h>
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/channel.h"
33 #include "asterisk/module.h"
34 #include "asterisk/pbx.h"
35
36
37 static char *tdesc = "Tell Asterisk to not maintain a CDR for the current call";
38
39 static char *nocdr_descrip = 
40 "  NoCDR(): This application will tell Asterisk not to maintain a CDR for the\n"
41 "current call.\n";
42
43 static char *nocdr_app = "NoCDR";
44 static char *nocdr_synopsis = "Tell Asterisk to not maintain a CDR for the current call";
45
46 STANDARD_LOCAL_USER;
47
48 LOCAL_USER_DECL;
49
50 static int nocdr_exec(struct ast_channel *chan, void *data)
51 {
52         struct localuser *u;
53         
54         LOCAL_USER_ADD(u);
55
56         if (chan->cdr) {
57                 ast_cdr_free(chan->cdr);
58                 chan->cdr = NULL;
59         }
60
61         LOCAL_USER_REMOVE(u);
62
63         return 0;
64 }
65
66 int unload_module(void)
67 {
68         int res;
69
70         res = ast_unregister_application(nocdr_app);
71
72         STANDARD_HANGUP_LOCALUSERS;
73
74         return res;
75 }
76
77 int load_module(void)
78 {
79         return ast_register_application(nocdr_app, nocdr_exec, nocdr_synopsis, nocdr_descrip);
80 }
81
82 char *description(void)
83 {
84         return tdesc;
85 }
86
87 int usecount(void)
88 {
89         int res;
90         STANDARD_USECOUNT(res);
91         return res;
92 }
93
94 char *key()
95 {
96         return ASTERISK_GPL_KEY;
97 }