Setting options values.

Functions

 __argsparse_set_option (option)
 Resolv option-specific setter function and invoke it.
 argsparse_set_alias (option)
 "alias" property specific option-setting hook.
 argsparse_set_cumulative_option (option, value)
 "cumulative" property specific option-setting hook.
 argsparse_set_cumulativeset_option (option, value)
 "cumulativeset" property specific option-setting hook.
 argsparse_set_option (option, value)
 Default option-setting hook.
 argsparse_set_option_with_value (option, value)
 "value" property specific option-setting hook.
 argsparse_set_option_without_value (option)
 The option-setting hook for options not accepting values.

Function Documentation

__argsparse_set_option ( option   ) 

Resolv option-specific setter function and invoke it.

Check if a user-defined option setting function (set_option_<optionname>) has been defined or if the generic argsparse_set_option() function is to be used. Then invoke the that function with the option name as first parameter. If a value for the option is involved, it is passed as a second parameter.

Parameters:
option an option name.
Returns:
the setter function return code
argsparse_set_alias ( option   ) 

"alias" property specific option-setting hook.

Parameters:
option an option name.

When an option is an alias for other option(s), then set the aliases options.

argsparse_set_cumulative_option ( option  ,
value   
)

"cumulative" property specific option-setting hook.

Default action to take for cumulative options. Store value into an array whose name is generated using argsparse_get_cumulative_array_name().

Parameters:
option an option name.
value the value put on command line for given option.
argsparse_set_cumulativeset_option ( option  ,
value   
)

"cumulativeset" property specific option-setting hook.

Parameters:
option an option name.
value a new value for the option.

Default action to take for cumulativeset options. Act exactly like argsparse_set_cumulative_option() except that values are not duplicated in the cumulated values array.

argsparse_set_option ( option  ,
value   
)

Default option-setting hook.

Parameters:
option The option being set.
value the value of the option (optional).

This function will be called by argsparse_parse_options() whenever an option is being and no custom setting hook is define for this option. Depending of the properties of the option a more specific setting hook will be called.

argsparse_set_option_with_value ( option  ,
value   
)

"value" property specific option-setting hook.

Parameters:
option an option name.
value the value put on command line for given option.
argsparse_set_option_without_value ( option   ) 

The option-setting hook for options not accepting values.

Parameters:
option an option name.
Return values:
0 
 All Files Functions Variables

Generated on 6 Mar 2015 for The Bash Argsparse Library by  doxygen 1.6.1