Ini_GetUInt
- Updated2023-02-21
- 2 minute(s) read
int Ini_GetUInt (IniText handle, const char sectionName[], const char tagName[], unsigned int *unsignedIntegerValue);
Purpose
Obtains the unsigned integer value associated with tagName in the section identified by sectionName.
Parameters
| Input | ||
| Name | Type | Description |
| handle | IniText | A handle returned from Ini_New. It represents the list of in-memory tag/value pairs. |
| sectionName | const char [] | The section name under which to find the tag/value pair. |
| tagName | const char [] | The tag name in the tag/value pair. |
| Output | ||
| Name | Type | Description |
| unsignedIntegerValue | unsigned int | The variable into which the unsigned integer value associated with tagName is placed. If tagName cannot be found, or the unsigned integer value is empty, or an error occurs, the variable is left untouched. |
Return Value
| Name | Type | Description | ||||
| status | int | Indicates whether a valid tag/unsigned integer pair was found with the specified tagName in the section specified by sectionName. A positive return value indicates that a tag/unsigned integer pair was found, and that the unsigned integer portion of the pair was a valid ASCII decimal representation of an unsigned integer. A zero indicates that no tag/unsigned integer pair was found, or that the unsigned integer portion was empty. 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. For this function, the only errors you might encounter are:
|
Additional Information
Library: Reading/Writing .ini-Style Files
Include file: toolbox\inifile.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later