cli_inline_parms_t Struct Reference

CLI inline parser parameter block. More...

#include <cli.h>

Collaboration diagram for cli_inline_parms_t:

Data Fields
obj_template_t *	obj
	obj_template_t of the container that should be used to validate the input against the child nodes of this container
boolean	valonly
	valonly More...
boolean	script
	script More...
boolean	autocomp
	autocomp More...
boolean	rawxml
	rawxml XML parsing mode More...
boolean	hide_unknown_error
	hide_unknown_error used for show raw testing of the command line to see if it should be processed or skipped dues to unknown nodes More...
cli_mode_t	mode
	mode More...
cli_xml_buffer_fn_t	cbfn
	cbfn inline XML data only: callback for XML buffer parsing
cli_var_replace_fn_t	cbfn2
	cbfn2 inline data variable replacement callback function

Detailed Description

CLI inline parser parameter block.

• Used by cli_parse_inline2 function

Field Documentation

autocomp

boolean autocomp

autocomp

• TRUE if parameter auto-completion should be tried if any specified parameters are not matches for the specified parmset
  
• FALSE if exact match only is desired

hide_unknown_error

boolean hide_unknown_error

hide_unknown_error used for show raw testing of the command line to see if it should be processed or skipped dues to unknown nodes

• TRUE if ERR_NCX_UNKNOWN_PARM should be suppresssed
• FALSE if this error should not be suppressed

mode

cli_mode_t mode

mode

• CLI_MODE_PROGRAM if calling with real (argc, argv) parameters; these may need some prep work
• CLI_MODE_COMMAND if calling from yangcli or some other internal command parser. These strings will not be preped at all

rawxml

boolean rawxml

rawxml XML parsing mode

• TRUE if inline XML should be saved
• FALSE to parse as 'obj'

script

boolean script

script

• TRUE if calling from a script
• FALSE if interactive

valonly

boolean valonly

valonly

• TRUE if only the values presented should be checked, no defaults, missing parms (Step 1 & 2 only)
  
• FALSE if all the tests and procedures should be done

---

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

• cli.h