pure functiongetInteger
Get scalar Integer value from INI file
Extends from Interfaces.INI.getInteger (Get scalar Integer value from INI file).
Information
If strict=true and the line being read contains more than a name=value pair this function will return an error. However, when strict=false it will return the value and ignore the rest of the line.
For example
[example_section]
name=13 ;this is a comment
In this example, if strict=true we will get an error but if strict=false it will return the value 13
Inputs
| Type | Name | Default | Description |
|---|---|---|---|
| String | varName (from partialGetInteger) | Key | |
| String | section (from getInteger) | "" | Section |
| Types.ExternINIFile | ini (from getInteger) | External INI file object | |
| Boolean | strict (from getInteger) | true | Return an error if there are characters on the line that aren't part of the value |
Outputs
| Type | Name | Default | Description |
|---|---|---|---|
| Integer | y (from partialGetInteger) | Integer value | |
| Boolean | exist (from partialGetInteger) | = true, if varName exits; = false, if it does not exist and y is set to 0 |