Asterisk.org: Developer Documentation (28 Oct 2009)

Wed Oct 28 15:49:28 2009

## Asterisk developer's documentation

# ast_cli_entry Struct Reference

A command line entry. More...

`#include <cli.h>`

Collaboration diagram for ast_cli_entry:

[legend]

## Data Fields

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

## Detailed Description

A command line entry.

Definition at line 46 of file cli.h.

## Field Documentation

char* cmda[AST_MAX_CMD_LEN]

Null terminated list of the words of the command

Definition at line 48 of file cli.h.

Referenced by __ast_cli_generator(), ast_cli_register(), find_cli(), and help_workhorse().

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

Generate a list of possible completions for a given word

Referenced by __ast_cli_generator().

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

Referenced by ast_cli_command().

int inuse

For keeping track of usage

Definition at line 60 of file cli.h.

Referenced by ast_cli_command(), and ast_cli_unregister().

struct ast_cli_entry* next`[read]`

For linking

Definition at line 58 of file cli.h.

Referenced by __ast_cli_generator(), ast_cli_register(), ast_cli_unregister(), find_cli(), and help_workhorse().

char* summary

Summary of the command (< 60 characters)

Definition at line 52 of file cli.h.

Referenced by help_workhorse().

char* usage

Detailed usage information

Definition at line 54 of file cli.h.

Referenced by ast_cli_command(), and handle_help().

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

- cli.h