Asterisk.org: Developer Documentation (28 Oct 2009)

Wed Oct 28 15:49:26 2009

## Asterisk developer's documentation

# 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.
unsigned int | 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).

Definition at line 271 of file 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.

Definition at line 276 of file app.h.

Referenced by ast_app_parse_options().

unsigned int flag

The flag bit that represents this option.

Definition at line 273 of file app.h.

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

- app.h