Ini_SetMaxValueLineLength
- Updated2023-02-21
- 1 minute(s) read
int Ini_SetMaxValueLineLength (IniText handle, int maxValueLineLength);
Purpose
By default, when you add an item to the Ini_Text and write that Ini_Text using Ini_WriteToFile or Ini_WriteGeneric, Ini_WriteToFile and Ini_WriteGeneric split the item to span multiple lines if the value exceeds 80 characters.
This function changes the maximum value length before items in the Ini_Text split to span multiple lines. If you specify a value of 0, items are not split and are written as single lines. This can be useful when writing .ini files that are read by applications that do not expect values to span multiple lines.
Parameters
| Input | ||
| Name | Type | Description |
| handle | IniText | A handle returned from Ini_New. It represents the list of in-memory tag/value pairs. |
| maxValueLineLength | int | Specify a value greater than zero and less than the maximum Ini file line length to set the maximum value length that is written to a single line. If a value exceeds this length the item is split to span multiple lines so that the portion of the value on each line is less than the specified maximum. If you specify a value of 0 items are not split and are written as single lines. |
Return Value
| Name | Type | Description |
| previousSetting | int | Returns the previous value of this setting for the IniText. |
Additional Information
Library: Reading/Writing .ini-Style Files
Include file: toolbox\inifile.h
LabWindows/CVI compatibility: LabWindows/CVI 2012 and later