Fix ENUM documentation (bug #3698)
[asterisk/asterisk.git] / include / asterisk / enum.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * ENUM support
5  * 
6  * Copyright (C) 1999-2005, Digium, inc
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 /*!     \file enum.h
15         \brief DNS and ENUM functions
16 */
17
18 #ifndef _ASTERISK_ENUM_H
19 #define _ASTERISK_ENUM_H
20 #include <asterisk/channel.h>
21 /*! \brief Lookup entry in ENUM Returns 1 if found, 0 if not found, -1 on hangup 
22         \param chan     Channel
23         \param number   Number in E164 format without the + (for e164.arpa) or format 
24                         requested by enum service used (enum.conf)
25         \param location Number returned (or SIP uri)
26         \param maxloc   Max length
27         \param tech     Technology (from url scheme in response)
28         \param maxtech  Max length
29 */
30 extern int ast_get_enum(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech);
31
32 /*!     \brief Lookup DNS TXT record (used by app TXTCIDnum
33         \param chan     Channel
34         \param number   E164 number without the +
35         \param locatio  Number returned (or SIP uri)
36         \param maxloc   Max length of number
37         \param tech     Technology (not used in TXT records)
38         \param maxtech  Max length
39         \param txt      Text string (return value)
40         \param maxtxt   Max length of "txt"
41 */
42 extern int ast_get_txt(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech, char *txt, int maxtxt);
43
44 extern int ast_enum_init(void);
45 extern int ast_enum_reload(void);
46 #endif