kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-18 18:58:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge changes from team/group/appdocsxml

Browse Source 
This commit introduces the first phase of an effort to manage documentation of the
interfaces in Asterisk in an XML format.  Currently, a new format is available for
applications and dialplan functions.  A good number of conversions to the new format
are also included.

For more information, see the following message to asterisk-dev:

http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2008-11-01 21:10:07 +00:00
parent 1fef0f63bb
commit 5b168ee34b
111 changed files with 8063 additions and 2478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
funcs/func_extstate.c
View File

@@ -36,6 +36,29 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/utils.h"
#include "asterisk/devicestate.h"
/*** DOCUMENTATION
<function name="EXTENSION_STATE" language="en_US">
<synopsis>
Get an extension's state.
</synopsis>
<syntax argsep="@">
<parameter name="extension" required="true" />
<parameter name="context">
<para>If it is not specified defaults to <literal>default</literal>.</para>
</parameter>
</syntax>
<description>
<para>The EXTENSION_STATE function can be used to retrieve the state from any
hinted extension. For example:</para>
<para>NoOp(1234@default has state ${EXTENSION_STATE(1234)})</para>
<para>NoOp(4567@home has state ${EXTENSION_STATE(4567@home)})</para>
<para>The possible values returned by this function are:</para>
<para>UNKNOWN | NOT_INUSE | INUSE | BUSY | INVALID | UNAVAILABLE | RINGING |
RINGINUSE | HOLDINUSE | ONHOLD</para>
</description>
</function>
***/
static const char *ast_extstate_str(int state)
{
const char *res = "UNKNOWN";
@@ -98,17 +121,6 @@ static int extstate_read(struct ast_channel *chan, const char *cmd, char *data,
static struct ast_custom_function extstate_function = {
.name = "EXTENSION_STATE",
.synopsis = "Get an extension's state",
.syntax = "EXTENSION_STATE(extension[@context])",
.desc =
" The EXTENSION_STATE function can be used to retrieve the state from any\n"
"hinted extension. For example:\n"
" NoOp(1234@default has state ${EXTENSION_STATE(1234)})\n"
" NoOp(4567@home has state ${EXTENSION_STATE(4567@home)})\n"
"\n"
" The possible values returned by this function are:\n"
"UNKNOWN | NOT_INUSE | INUSE | BUSY | INVALID | UNAVAILABLE | RINGING\n"
"RINGINUSE | HOLDINUSE | ONHOLD\n",
.read = extstate_read,
};