Ini_RemoveItem
- Updated2023-02-21
- 1 minute(s) read
int Ini_RemoveItem (IniText handle, const char sectionName[], const char tagName[]);
Purpose
Removes an item from the list of in–memory tag/value pairs. If the item is a string that was split into multiple lines, then all of the lines are removed.
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 name of the section containing the item to remove. |
| tagName | const char [] | The tag name of the tag/value pair to remove. |
Return Value
| Name | Type | Description |
| result | int | Indicates if the specified item was removed from the tag/value pairs specified by handle. If the item was removed, a 1 is returned. If the item was not found, a 0 is returned. |
Additional Information
Library: Reading/Writing .ini-Style Files
Include file: toolbox\inifile.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Example
Refer to toolbox\ini.cws for an example of using the Ini_RemoveItem function.