complete_entry_opt Struct Reference

Struct describing a completion option entry. More...

Collaboration diagram for complete_entry_opt:

[legend]

Data Fields
wchar_t	short_opt
	Short style option.
const wchar_t *	long_opt
	Long style option.
const wchar_t *	comp
	Arguments to the option.
const wchar_t *	desc
	Description of the completion.
const wchar_t *	condition
	Condition under which to use the option.
int	result_mode
	Must be one of the values SHARED, NO_FILES, NO_COMMON, EXCLUSIVE, and determines how completions should be performed on the argument after the switch.
int	old_mode
	True if old style long options are used.
struct complete_entry_opt *	next
	Next option in the linked list.
int	flags
	Completion flags.

---

Detailed Description

Struct describing a completion option entry.

If short_opt and long_opt are both zero, the comp field must not be empty and contains a list of arguments to the command.

If either short_opt or long_opt are non-zero, they specify a switch for the command. If comp is also not empty, it contains a list of non-switch arguments that may only follow directly after the specified switch.

---

Field Documentation

int complete_entry_opt::result_mode

Must be one of the values SHARED, NO_FILES, NO_COMMON, EXCLUSIVE, and determines how completions should be performed on the argument after the switch.

Referenced by complete_add(), complete_param(), and complete_print().

---

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

• complete.c