Ini_PutBoolean
- Updated2023-02-21
- 1 minute(s) read
int Ini_PutBoolean (IniText handle, const char sectionName[], const char tagName[], int booleanValue);
Purpose
Adds a tag/boolean pair to the tag/value list identified by handle. The boolean value is associated with the tag identified by tagName in the section identified by sectionName. If you specify a nonzero value, True is associated with the tag. Otherwise, False is associated with the tag.
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 place the tag/value pair. |
| tagName | const char [] | The tag name to use in the tag/value pair. |
| booleanValue | int | Specify a nonzero value or select True in the function panel to associate True with the tagName. Specify 0 or select False in the function panel to associate False with the tagName. |
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. 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 4.0 and later