ast_app_option Struct Reference

A structure to hold the description of an application 'option'. More...

#include <app.h>


Data Fields

unsigned int arg_index
 The index of the entry in the arguments array that should be used for this option's argument.
uint64_t flag
 The flag bit that represents this option.


Detailed Description

A structure to hold the description of an application 'option'.

Application 'options' are single-character flags that can be supplied to the application to affect its behavior; they can also optionally accept arguments enclosed in parenthesis.

These structures are used by the ast_app_parse_options function, uses this data to fill in a flags structure (to indicate which options were supplied) and array of argument pointers (for those options that had arguments supplied).

Examples:

/tmp/asterisk-trunk/trunk/main/app.c.

Definition at line 1246 of file include/asterisk/app.h.


Field Documentation

unsigned int arg_index

The index of the entry in the arguments array that should be used for this option's argument.

Examples:
/tmp/asterisk-trunk/trunk/main/app.c.

Definition at line 1251 of file include/asterisk/app.h.

Referenced by parse_options().

uint64_t flag

The flag bit that represents this option.

Definition at line 1248 of file include/asterisk/app.h.


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

Generated on Thu Apr 16 06:34:57 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6