79. GetInstArgs

Get client arguments

79.1. Authors

  • Anas Nashif <nashif@suse.de>

79.2. Summary of Module Globals

List of Global Functions

  • Buttons - Returns map of client parameters only with keys: "enable_back" and "enable_next"

  • ButtonsProposal - Returns map of client parameters only with keys: "enable_back", "enable_next", and "proposal"

  • argmap - Returns map of client parameters

  • automatic_configuration - Is the automatic configuraton just in progress?

  • enable_back - Should be the [Back] button enabled?

  • enable_next - Should be the [Next] button enabled?

  • going_back - Are we going back from the previous dialog?

  • proposal - Returns name of the proposal

List of Global Variables

    79.3. Global Functions

    79.3.1. Buttons

    Returns map of client parameters only with keys: "enable_back" and "enable_next"

    Function parameters

    • boolean back

    • boolean next

    Return value

    • map - of parameters

    Example 13. 

    	GetInstArgs::Buttons() -> $[
    		"enable_back" : false,
    		"enable_next" : true
    	]


    79.3.2. ButtonsProposal

    Returns map of client parameters only with keys: "enable_back", "enable_next", and "proposal"

    Function parameters

    • boolean back

    • boolean next

    • string proposal_name

    Return value

    • map - of parameters

    Example 14. 

    	GetInstArgs::ButtonsProposal() -> $[
    		"enable_back" : true,
    		"enable_next" : true,
    		"proposal"  : "initial"
    	]


    79.3.3. argmap

    Returns map of client parameters

    Return value

    • map - of parameters

    Example 15. 

    	GetInstArgs::argmap() -> $[
    		"enable_back" : true,
    		"enable_next" : true,
    		"going_back"  : true,
    		"anything"    : "yes, of course",
    	]


    79.3.4. automatic_configuration

    Is the automatic configuraton just in progress?

    Return value

    • boolean - if running the automatic configuration

    79.3.5. enable_back

    Should be the [Back] button enabled?

    Return value

    • boolean - whether enabled or not

    79.3.6. enable_next

    Should be the [Next] button enabled?

    Return value

    • boolean - whether enabled or not

    79.3.7. going_back

    Are we going back from the previous dialog?

    Return value

    • boolean - whether going_back or not

    79.3.8. proposal

    Returns name of the proposal

    Return value

    • string - proposal name

    Example 16. 

    	GetInstArgs::proposal() -> "initial"
    	GetInstArgs::proposal() -> "network"
    	GetInstArgs::proposal() -> "hardware"


    79.4. Global Variables

    79.5. Module Requirements

    none