Thu Oct 11 06:50:02 2012

Asterisk developer's documentation


agi_command Struct Reference

#include <agi.h>

Collaboration diagram for agi_command:

Collaboration graph
[legend]

Data Fields

char * cmda [AST_MAX_CMD_LEN]
int dead
enum ast_doc_src docsrc
int(* handler )(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
struct {
   struct agi_command *   next
list
struct ast_modulemod
char * seealso
char * summary
char * syntax
char * usage

Detailed Description

Definition at line 41 of file agi.h.


Field Documentation

char* cmda[AST_MAX_CMD_LEN]

Null terminated list of the words of the command

Definition at line 42 of file agi.h.

Referenced by ast_agi_register(), ast_agi_unregister(), find_command(), help_workhorse(), and write_htmldump().

int dead

Does this application run dead

Definition at line 51 of file agi.h.

Referenced by agi_handle_command(), handle_cli_agi_show(), and help_workhorse().

Where the documentation come from.

Definition at line 57 of file agi.h.

Referenced by ast_agi_register(), ast_agi_unregister(), and handle_cli_agi_show().

int(* handler)(struct ast_channel *chan, AGI *agi, int argc, char *argv[])

Handler for the command (channel, AGI state, # of arguments, argument list). Returns RESULT_SHOWUSAGE for improper arguments

Referenced by agi_handle_command().

struct { ... } list

struct ast_module* mod [read]

Pointer to module that registered the agi command

Definition at line 59 of file agi.h.

Referenced by agi_handle_command(), and ast_agi_register().

struct agi_command* next [read]

Definition at line 61 of file agi.h.

char* seealso

See also content

Definition at line 55 of file agi.h.

Referenced by ast_agi_register(), ast_agi_unregister(), and handle_cli_agi_show().

char* summary

Summary of the command (< 60 characters)

Definition at line 47 of file agi.h.

Referenced by ast_agi_register(), ast_agi_unregister(), handle_cli_agi_show(), help_workhorse(), and write_htmldump().

char* syntax

AGI command syntax description

Definition at line 53 of file agi.h.

Referenced by ast_agi_register(), ast_agi_unregister(), and handle_cli_agi_show().

char* usage

Detailed usage information

Definition at line 49 of file agi.h.

Referenced by agi_handle_command(), ast_agi_register(), ast_agi_unregister(), handle_cli_agi_show(), and write_htmldump().


The documentation for this struct was generated from the following file:

Generated on Thu Oct 11 06:50:03 2012 for Asterisk - the Open Source PBX by  doxygen 1.5.6