Ini_GetEncoding
- Updated2023-02-21
- 1 minute(s) read
int Ini_GetEncoding (IniText handle, IniFileEncodingType *iniFileEncoding);
Purpose
Gets the encoding type for the in-memory object identified by handle.
Parameters
| Input | ||
| Name | Type | Description |
| handle | IniText | A handle returned from Ini_New. It represents the list of in-memory tag/value pairs. Returns an error when a zero is passed. |
| iniFileEncoding | IniFileEncodingType * | A pointer to a variable which receives the encoding of data stored in the list of in-memory tag/value pairs. See function Ini_SetEncodings for the possible values. |
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 in the range of –1 to –999, the error code is defined in userint.h. If the value is in the range of –5000 to –5999, the error code is defined in toolbox.h. For this function, the only error you are likely to encounter is:
|
Additional Information
Library: Reading/Writing .ini-Style Files
Include file: toolbox\inifile.h
LabWindows/CVI compatibility: LabWindows/CVI 2020 and later