Main Page | Alphabetical List | Data Structures | File List | Data Fields | Globals

ast_cli_entry Struct Reference

A command line entry */. More...

#include <cli.h>

Collaboration diagram for ast_cli_entry:

Collaboration graph
[legend]

Data Fields

char * cmda [AST_MAX_CMD_LEN]
int(* handler )(int fd, int argc, char *argv[])
char * summary
char * usage
char *(* generator )(char *line, char *word, int pos, int state)
ast_cli_entrynext
int inuse

Detailed Description

A command line entry */.

Definition at line 37 of file cli.h.


Field Documentation

char* cmda[AST_MAX_CMD_LEN]
 

Null terminated list of the words of the command

Definition at line 39 of file cli.h.

Referenced by ast_cli_register().

char*(* generator)(char *line, char *word, int pos, int state)
 

Generate a list of possible completions for a given word

int(* handler)(int fd, int argc, char *argv[])
 

Handler for the command (fd for output, # of arguments, argument list). Returns RESULT_SHOWUSAGE for improper arguments

int inuse
 

For keeping track of usage

Definition at line 51 of file cli.h.

Referenced by ast_cli_unregister().

struct ast_cli_entry* next
 

For linking

Definition at line 49 of file cli.h.

Referenced by ast_cli_register(), and ast_cli_unregister().

char* summary
 

Summary of the command (< 60 characters)

Definition at line 43 of file cli.h.

char* usage
 

Detailed usage information

Definition at line 45 of file cli.h.


The documentation for this struct was generated from the following file:
Generated on Sat Jun 12 16:41:52 2004 for Asterisk by doxygen 1.3.7