Gambas Documentation - /comp/gb.args/args/getfloat

/comp/gb.args/args/getfloat

# Args.GetFloat (gb.args)

Static Function GetFloat ( ShortName As String, LongName As String [ , Description As String, ArgName As String, Default As Float ] ) As Float

Define an option that takes one floating point number argument, and return it.

- ShortName is the short name of the option without the dash. (i.e. `"o"` for `-o`).

- LongName is the full name of the option without the two dashes (i.e. `"option"` for `--option`).

- Description is an optional text that describes the option. This will be used if the `--help` option is requested.

- ArgName is the name of the option argument used by the `--help` option.

- Default is the default value that will be returned if the option is not specified.

The floating point number always uses the American format.