Skip to content

Commit fb203ce

Browse files
authored
Update INIConfigIO.md
1 parent bc3b0c9 commit fb203ce

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

docs/usage/INIConfigIO.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,32 @@ DDS.Net.Connector.Helpers.**INIConfigIO** provides an easy to use interface for
66
INIConfigIO(string filename, ILogger? logger = null)
77
```
88

9-
It can be simply instantiated:
9+
It can be simply instantiated, like:
1010

1111
```csharp
1212
INIConfigIO iniFile = new INIConfigIO("file.ini");
1313
```
1414

1515

16-
Its instance functions help in reading and writing the INI file, they include:
16+
Instance functions help in reading and writing the INI file:
1717

18-
* Clear() - Clears the in-memory data but does not effect the file till it is saved.
19-
* SaveFile() - Saves the in-memory data into the given file.
18+
* *Clear()* - Clears the in-memory data but does not effect the file till it is saved.
19+
* *SaveFile()* - Saves the in-memory data into the given file.
2020

21-
* IEnumerable<string> GetSectionNames() - Gets all the section names present in the file.
22-
* string GetString(string key, string defaultValue = "") - Gets a value as a string, default value is returned when the key is not present in the file.
23-
* int GetInteger(string key, int defaultValue = -1) - Gets a value as an integer, default value is returned when the key is not present in the file.
24-
* float GetFloat(string key, float defaultValue = 0) - Gets a value as a float, default value is returned when the key is not present in the file.
25-
* double GetDouble(string key, double defaultValue = 0) - Gets a value as a double, default value is returned when the key is not present in the file.
21+
* *IEnumerable*<*string*> *GetSectionNames()* - Gets all the section names present in the file.
22+
*
23+
* *string* *GetString* (string *key*, string *defaultValue* = "") - Gets a value as a string, default value is returned when the key is not present in the file.
24+
* *int* *GetInteger* (string *key*, int *defaultValue* = -1) - Gets a value as an integer, default value is returned when the key is not present in the file.
25+
* *float* *GetFloat* (string *key*, float *defaultValue* = 0) - Gets a value as a float, default value is returned when the key is not present in the file.
26+
* *double* *GetDouble* (string *key*, double *defaultValue* = 0) - Gets a value as a double, default value is returned when the key is not present in the file.
2627

27-
* SetString(string key, string value) - Sets specified key's value to the given value
28-
* SetInteger(string key, int value) - Sets specified key's value to the given value
29-
* SetFloat(string key, float value) - Sets specified key's value to the given value
30-
* SetDouble(string key, double value) - Sets specified key's value to the given value
28+
* *SetString* (string *key*, string *value*) - Sets specified key's value to the given value
29+
* *SetInteger* (string *key*, int *value*) - Sets specified key's value to the given value
30+
* *SetFloat* (string *key*, float *value*) - Sets specified key's value to the given value
31+
* *SetDouble* (string *key*, double *value*) - Sets specified key's value to the given value
3132

3233

33-
For example, consider the following file:
34+
For example, consider the following INI file:
3435

3536
```ini
3637
[A]

0 commit comments

Comments
 (0)