Ini_ReadFromFile
- Updated2023-02-21
- 2 minute(s) read
int Ini_ReadFromFile (IniText handle, const char pathname[]);
Purpose
Reads the tag/value pairs in the file identified by pathname into the list identified by handle.
If you want to read the data from a source other than a file or the Windows Registry, use the Ini_ReadGeneric function.
Parameters
| Input | ||
| Name | Type | Description |
| handle | IniText | A handle returned from Ini_New. It represents the list of in-memory tag/value pairs. |
| pathname | const char [] | The pathname of the file from which to read the tag/value pairs. If the pathname is not absolute, the file is located relative to the current working directory. |
Return Value
| Name | Type | Description | ||||||||||||||||||||
| status | int | Indicates whether the function was successful. A zero indicates success. A negative value indicates an error. If the value is from –1 to –999, it is one of the error values defined in userint.h. If the value is from –5000 to –5999, it is one of the error values defined in toolbox.h. Among the more commonly encountered errors are:
|
Additional Information
Library: Reading/Writing .ini-Style Files
Include file: toolbox\inifile.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Examples
Refer to the following examples that use the Ini_ReadFromFile function:
- compiler\versioning\versioning.cws
Open example - toolbox\ini.cws
Open example