Методы работы с ini-файлами. Подробнее...

Структуры данных
struct	iniBinaryArray
	Структура для сохранения массива бинарных данных в ini-файле. Подробнее...

struct	iniCoords

struct	iniIntArray
	Структура для сохранения массива целых чисел в ini-файле. Подробнее...

struct	iniRect

Определения типов
typedef T_INI_FILE *	INI_FILE

Работа с ini-файлом
STATUS	iniFileChangeName (INI_FILE IF, const char *newName)
	Изменить имя ini-файла. Подробнее...

STATUS	iniFileClose (INI_FILE IF)
	Закрыть ini-файл с сохранением изменений. Подробнее...

INI_FILE	iniFileCreate (const char *ifName)
	Создать новый идентификатор ini-файла. Подробнее...

STATUS	iniFileFlush (INI_FILE IF)
	Сохранить все изменения в ini-файле. Подробнее...

void	iniFileFree (INI_FILE IF)
	Закрыть ini-файл без сохранения изменений. Подробнее...

INI_FILE	iniFileOpen (const char *ifName)
	Открыть и считать ini-файл. Подробнее...

STATUS	iniFilePrint (INI_FILE IF)
	Печать файла. Подробнее...

Общие функции работы с содержимым файла
bool	iniFileCheckIfItemExists (INI_FILE IF, const char Section, const char Name)
	Проверка наличия параметра. Подробнее...

bool	iniFileCheckIfSectionExists (INI_FILE iniFileDesc, const char *sectionName)
	Проверка наличия секции в ini-файле. Подробнее...

STATUS	iniFileDeleteItem (INI_FILE iniFileDesc, const char sectionName, const char itemName)

STATUS	iniFileDeleteSection (INI_FILE iniFileDesc, const char *sectionName)

char *	iniFileItemName (INI_FILE IF, const char *Section, int ItemNum)
	Поиск параметра по порядковому номеру. Подробнее...

STATUS	iniFileRenameItem (INI_FILE iniFileDesc, const char sectionName, const char oldItemName, const char *newItemName)

STATUS	iniFileRenameSection (INI_FILE iniFileDesc, const char oldSectionName, const char newSectionName)

char *	iniFileSectionName (INI_FILE IF, int SectionNum)
	Поиск секции по порядковому номеру. Подробнее...

Функции для работы с коментариями к файлу, секциям и пунктам.
STATUS	iniFileDeleteFileBottomComment (INI_FILE iniFileDesc)

STATUS	iniFileDeleteFileTopComment (INI_FILE iniFileDesc)

STATUS	iniFileDeleteItemComment (INI_FILE iniFileDesc, const char sectionName, const char itemName)

STATUS	iniFileDeleteSectionComment (INI_FILE iniFileDesc, const char *sectionName)

sVector *	iniFileGetFileBottomComment (INI_FILE iniFileDesc)

sVector *	iniFileGetFileTopComment (INI_FILE iniFileDesc)

sVector *	iniFileGetItemComment (INI_FILE iniFileDesc, const char sectionName, const char itemName)

sVector *	iniFileGetSectionComment (INI_FILE iniFileDesc, const char *sectionName)

STATUS	iniFileWriteFileBottomCommentLine (INI_FILE iniFileDesc, const char *commentLine)

STATUS	iniFileWriteFileTopCommentLine (INI_FILE iniFileDesc, const char *commentLine)

STATUS	iniFileWriteItemCommentLine (INI_FILE iniFileDesc, const char sectionName, const char itemName, const char *commentLine)

STATUS	iniFileWriteSectionCommentLine (INI_FILE iniFileDesc, const char sectionName, const char commentLine)

Целые числа
int	iniFileReadInteger (INI_FILE IF, const char Section, const char Name, int defVal)
	Считать целое число из ini-файла. Подробнее...

void	iniFileWriteInteger (INI_FILE IF, const char Section, const char Name, int Val)
	Записать целое число в ini-файл. Подробнее...

Целые числа в hex-формате
int	iniFileReadHex (INI_FILE IF, const char Section, const char Name, int defVal)
	Считать целое число в формате HEX из ini-файла. Подробнее...

void	iniFileWriteHex (INI_FILE IF, const char Section, const char Name, int Val)
	Записать целое число в формате HEX в ini-файл. Подробнее...

Логическое значение
int	iniFileReadBoolean (INI_FILE IF, const char Section, const char Name, int defVal)
	Считать логическое значение из ini-файла. Подробнее...

void	iniFileWriteBoolean (INI_FILE IF, const char Section, const char Name, int Val)
	Записать логическое значение в ini-файл. Подробнее...

Строки
const char *	iniFileReadConstString (INI_FILE IF, const char Section, const char Name, const char *defVal)
	Считать текстовую строку из ini-файла. Подробнее...

char *	iniFileReadString (INI_FILE IF, const char Section, const char Name, const char *defVal)
	Считать текстовую строку из ini-файла и вернуть её копию. Подробнее...

void	iniFileWriteString (INI_FILE IF, const char Section, const char Name, const char *Val)
	Записать строку в ini-файл. Подробнее...

Прямоугольные области
iniRect *	iniFileReadTextRect (INI_FILE iniFile, const char section, const char name, const iniRect *defVal)
	Считать данные о прямоугольной области. Подробнее...

void	iniFileWriteTextRect (INI_FILE iniFile, const char section, const char name, const iniRect *val)
	Записать данные о прямоугольной области. Подробнее...

Пары координат
iniCoords *	iniFileReadCoords (INI_FILE iniFile, const char section, const char name, const iniCoords *defVal)
	Считать пару координат. Подробнее...

void	iniFileWriteCoords (INI_FILE iniFile, const char section, const char name, const iniCoords *val)
	Записать пару координат. Подробнее...

Массивы целых чисел
iniIntArray *	iniFileReadIntArray (INI_FILE iniFile, const char section, const char name, const iniIntArray *defVal)
	Считать массив целых чисел. Подробнее...

void	iniFileWriteIntArray (INI_FILE iniFile, const char section, const char name, const iniIntArray *val)
	Записать массив целых чисел. Подробнее...

Массивы бинарных данных.
Формат данных в ini-файле: #5:AB78223109
iniBinaryArray *	iniFileReadBinaryArray (INI_FILE iniFile, const char section, const char name, const iniBinaryArray *defVal)
	Считать массив бинарных данных. Подробнее...

void	iniFileWriteBinaryArray (INI_FILE iniFile, const char section, const char name, const iniBinaryArray *val)
	Записать массив бинарных данных. Подробнее...

Подробное описание

Файл содержит описание методов работы с ini-файлами в ОС MULTEX-ARM.

См. также: Общее описание работы с ini-файлами в главе Работа с ini–файлами.

Типы

◆ INI_FILE

typedef T_INI_FILE* INI_FILE

Указатель на структуру ini-файла.

Функции

◆ iniFileChangeName()

STATUS iniFileChangeName	(	INI_FILE	IF,
		const char *	newName
	)

Функция изменяет имя ini-файла. При закрытии он будет сохранен с новым именем. Старый файл при этом не будет удален и останется со своим изначальным именем и содержимым.

Аргументы

IF	Указатель на открытый ini-файла.
newName	Указатель на строку нового имени файла.

Возвращает: OK при успехе.; ERROR в случае ошибки.

◆ iniFileCheckIfItemExists()

bool iniFileCheckIfItemExists	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name
	)

Функция проверять наличие параметра в ini-файле.

Аргументы

IF	Идентификатор ini-файла.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.

Возвращает: true, если параметр содержится в файле, иначе false.

◆ iniFileCheckIfSectionExists()

bool iniFileCheckIfSectionExists	(	INI_FILE	iniFileDesc,
		const char *	sectionName
	)

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции, в которой расположен параметр.

Возвращает: true если секция существует, иначе false.

◆ iniFileClose()

STATUS iniFileClose ( INI_FILE IF )

Функция закрывает ini-файл, освобождает все занятые ресурсы и сохраняет все изменения.

Аргументы

IF	Указатель на открытый ini-файл.

Возвращает: OK при успехе.; ERROR в случае ошибки.

◆ iniFileCreate()

INI_FILE iniFileCreate ( const char * ifName )

Создать идентификатор ini-файла, но не открывать файл и не заполнять идентификатор данными.

Аргументы

ifName Указатель на строку имени ini-файла.

Возвращает: Указатель, который следует использовать как идентификатор ini-файла.

Предупреждения: Даже при отсутствии файла лучше использовать функцию iniFileOpen().

◆ iniFileDeleteFileBottomComment()

STATUS iniFileDeleteFileBottomComment ( INI_FILE iniFileDesc )

Удалить комментарий в конце файла.

Аргументы

iniFileDesc Идентификатор ini-файла.

Возвращает: OK, если комментарий был успешно удален или не существовал, ERROR при ошибке.

◆ iniFileDeleteFileTopComment()

STATUS iniFileDeleteFileTopComment ( INI_FILE iniFileDesc )

Удалить комментарий в начале файла.

Аргументы

iniFileDesc Идентификатор ini-файла.

Возвращает: OK, если комментарий был успешно удален или не существовал, ERROR при ошибке.

◆ iniFileDeleteItem()

STATUS iniFileDeleteItem	(	INI_FILE	iniFileDesc,
		const char *	sectionName,
		const char *	itemName
	)

Удалить параметр из ини-файла.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции, в которой расположен параметр.
itemName	Название параметра.

Возвращает: OK, если параметр был успешно удален, ERROR иначе.

◆ iniFileDeleteItemComment()

STATUS iniFileDeleteItemComment	(	INI_FILE	iniFileDesc,
		const char *	sectionName,
		const char *	itemName
	)

Удалить комментарий параметра.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции, в которой расположен параметр.
itemName	Название параметра.

Возвращает: OK, если комментарий был успешно удален или не существовал, ERROR при ошибке или если параметр не существовал.

◆ iniFileDeleteSection()

STATUS iniFileDeleteSection	(	INI_FILE	iniFileDesc,
		const char *	sectionName
	)

Удалить секцию и все её параметры из ини-файла.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции.

Возвращает: OK, если секция была успешно удалена, ERROR иначе.

◆ iniFileDeleteSectionComment()

STATUS iniFileDeleteSectionComment	(	INI_FILE	iniFileDesc,
		const char *	sectionName
	)

Удалить комментарий секции.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции.

Возвращает: OK, если комментарий был успешно удален или не существовал, ERROR при ошибке или если секция не существовала.

◆ iniFileFlush()

STATUS iniFileFlush ( INI_FILE IF )

Сохранить все изменения в ini-файле. Файл будет сохранён в том же режиме обфускации, в котором он был открыт.

Аргументы

IF	Идентификатор ini-файла.

Возвращает: OK при успехе.; ERROR при ошибках записи и т.п.

◆ iniFileFree()

void iniFileFree ( INI_FILE IF )

Функция закрывает файл, освобождает все ресурсы, при этом ничего не сохраняет на диск.

Аргументы

IF	Указатель на открытый ini-файл.

◆ iniFileGetFileBottomComment()

sVector* iniFileGetFileBottomComment ( INI_FILE iniFileDesc )

Удалить комментарий в конце файла.

Аргументы

iniFileDesc Идентификатор ini-файла.

Возвращает: Вектор, содержащий char* элементы, указывающие на строки с комментариями или NULL, при отсутствии комментариев. Возвращенное значение нужно будет освободить - сначала free() для каждой строки и затем vector_Free() для вектора.

◆ iniFileGetFileTopComment()

sVector* iniFileGetFileTopComment ( INI_FILE iniFileDesc )

Удалить комментарий в начале файла.

Аргументы

iniFileDesc Идентификатор ini-файла.

Возвращает: Вектор, содержащий char* элементы, указывающие на строки с комментариями или NULL, при отсутствии комментариев. Возвращенное значение нужно будет освободить - сначала free() для каждой строки и затем vector_Free() для вектора.

◆ iniFileGetItemComment()

sVector* iniFileGetItemComment	(	INI_FILE	iniFileDesc,
		const char *	sectionName,
		const char *	itemName
	)

Получить комментарий параметра.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции, в которой расположен параметр.
itemName	Название параметра.

Возвращает: Вектор, содержащий char* элементы, указывающие на строки с комментариями или NULL, при отсутствии комментариев или параметра. Возвращенное значение нужно будет освободить - сначала free() для каждой строки и затем vector_Free() для вектора.

◆ iniFileGetSectionComment()

sVector* iniFileGetSectionComment	(	INI_FILE	iniFileDesc,
		const char *	sectionName
	)

Получить комментарий секции.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции.

Возвращает: Вектор, содержащий char* элементы, указывающие на строки с комментариями или NULL, при отсутствии комментариев или параметра. Возвращенное значение нужно будет освободить - сначала free() для каждой строки и затем vector_Free() для вектора.

◆ iniFileItemName()

char* iniFileItemName	(	INI_FILE	IF,
		const char *	Section,
		int	ItemNum
	)

Функция позволяет получить имя параметра с номером ItemNum из секции Section. Нумерация начинается с 0.

Аргументы

IF	Идентификатор ini-файла.
Section	Указатель на имя секции.
ItemNum	Порядковый номер параметра.

Возвращает: Указатель на строку, содержащую имя параметра.

◆ iniFileOpen()

INI_FILE iniFileOpen ( const char * ifName )

Функция открывает имеющийся (либо создает новый) ini-файл.

Аргументы

ifName Указатель на строку имени ini-файла.

Возвращает: Указатель, который следует использовать как идентификатор ini-файла.

Предупреждения: Сам файл не держится открытым, он закрывается после прочтения.

◆ iniFilePrint()

STATUS iniFilePrint ( INI_FILE IF )

Распечатать ini-файл в stdout.

Аргументы

IF	Идентификатор ini-файла.

Возвращает: OK при успехе, ERROR иначе.

◆ iniFileReadBinaryArray()

iniBinaryArray* iniFileReadBinaryArray	(	INI_FILE	iniFile,
		const char *	section,
		const char *	name,
		const iniBinaryArray *	defVal
	)

Функция считывает массив бинарных данных из ini-файла.

Аргументы

iniFile	Указатель на открытый ini-файл.
section	Указатель на имя секции.
name	Указатель на имя переменной.
defVal	Указатель на структуру, возвращаемую при неудачном поиске.

Возвращает: Указатель на структуру полученных данных iniBinaryArray.

Заметки: Необходимо освободить полученную структуру после использования!

◆ iniFileReadBoolean()

int iniFileReadBoolean	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		int	defVal
	)

Функция считывает из ini-файла значение переменной как логическое значение.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
defVal	Значение, возвращаемое при неудачном поиске.

Возвращает: Значение указанной переменной, либо defVal, если переменную найти не удалось.

◆ iniFileReadConstString()

const char* iniFileReadConstString	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		const char *	defVal
	)

Функция считывает из ini-файла значение переменной как текстовую строку и возвращает константный указатель на неё.

Предупреждения: Значение по указателю должно быть использовано/скопировано ДО закрытия ini-файла.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
defVal	Указатель на строку, возвращаемую при неудачном поиске.

Возвращает: Указатель на строку символов, либо на defVal, если переменную найти не удалось, либо NULL, если строку найти не удалось и defVal равен NULL.

◆ iniFileReadCoords()

iniCoords* iniFileReadCoords	(	INI_FILE	iniFile,
		const char *	section,
		const char *	name,
		const iniCoords *	defVal
	)

Функция считывает пару координат из ini-файла.

Аргументы

iniFile	Указатель на открытый ini-файл.
section	Указатель на имя секции.
name	Указатель на имя переменной.
defVal	Указатель на структуру, возвращаемую при неудачном поиске.

Возвращает: Указатель на структуру полученных данных iniCoords.

Предупреждения: Необходимо освободить полученную структуру после использования!

◆ iniFileReadHex()

int iniFileReadHex	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		int	defVal
	)

Функция считывает из ini-файла значение переменной как целое число в формате HEX.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
defVal	Значение, возвращаемое при неудачном поиске.

Возвращает: Значение указанной переменной, либо defVal, если переменную найти не удалось.

◆ iniFileReadIntArray()

iniIntArray* iniFileReadIntArray	(	INI_FILE	iniFile,
		const char *	section,
		const char *	name,
		const iniIntArray *	defVal
	)

Функция считывает массив целых чисел из ini-файла.

Аргументы

iniFile	Указатель на открытый ini-файл.
section	Указатель на имя секции.
name	Указатель на имя переменной.
defVal	Указатель на структуру, возвращаемую при неудачном поиске.

Возвращает: Указатель на структуру полученных данных iniIntArray.

Предупреждения: Необходимо освободить полученную структуру после использования!

◆ iniFileReadInteger()

int iniFileReadInteger	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		int	defVal
	)

Функция считывает из ini-файла значение переменной как целое число.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
defVal	Значение, возвращаемое при неудачном поиске.

Возвращает: Значение указанной переменной, либо defVal, если переменную найти не удалось.

◆ iniFileReadString()

char* iniFileReadString	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		const char *	defVal
	)

Функция считывает из ini-файла значение переменной как текстовую строку и возвращает её копию.

Предупреждения: Необходимо освободить полученную строку после использования.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
defVal	Указатель на строку, возвращаемую при неудачном поиске.

Возвращает: Указатель на строку символов, содержащую значение переменной или значениеdefVal, если переменную найти не удалось, либо NULL, если строку найти не удалось и defVal равен NULL.

◆ iniFileReadTextRect()

iniRect* iniFileReadTextRect	(	INI_FILE	iniFile,
		const char *	section,
		const char *	name,
		const iniRect *	defVal
	)

Функция получает данные о прямоугольной области из ini-файла.

Аргументы

iniFile	Указатель на открытый ini-файл.
section	Указатель на имя секции.
name	Указатель на имя переменной.
defVal	Указатель на структуру, возвращаемую при неудачном поиске.

Возвращает: Указатель на структуру полученных данных iniRect.

Предупреждения: Необходимо освободить полученную структуру после использования!

◆ iniFileRenameItem()

STATUS iniFileRenameItem	(	INI_FILE	iniFileDesc,
		const char *	sectionName,
		const char *	oldItemName,
		const char *	newItemName
	)

Переименовать параметр в ини-файле.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции, в которой расположен параметр.
oldItemName	Старое название параметра.
newItemName	Новое название параметра.

Возвращает: OK, если параметр был переименована, ERROR если параметр не был найден, если секция с newSectionName уже существует или в случае других ошибок.

◆ iniFileRenameSection()

STATUS iniFileRenameSection	(	INI_FILE	iniFileDesc,
		const char *	oldSectionName,
		const char *	newSectionName
	)

Переименовать секцию в ини-файле.

Аргументы

iniFileDesc	Идентификатор ini-файла.
oldSectionName	Старое название секции.
newSectionName	Новое название секции.

Возвращает: OK, если секция была переименована, ERROR если секция не была найдена, если секция с newSectionName уже существует или в случае других ошибок.

◆ iniFileSectionName()

char* iniFileSectionName	(	INI_FILE	IF,
		int	SectionNum
	)

Функция позволяет получить имя секции с номером SectionNum в структуре INI_FILE. Нумерация секций начинается с 0.

Аргументы

IF	Идентификатор ini-файла.
SectionNum	Порядковый номер секции.

Возвращает: Указатель на строку, содержащую имя параметра.

◆ iniFileWriteBinaryArray()

void iniFileWriteBinaryArray	(	INI_FILE	iniFile,
		const char *	section,
		const char *	name,
		const iniBinaryArray *	val
	)

Функция записывает массив бинарных данных в ini-файл.

Аргументы

iniFile	Указатель на открытый ini-файл.
section	Указатель на имя секции.
name	Указатель на имя переменной.
val	Указатель на записываемые данные.

◆ iniFileWriteBoolean()

void iniFileWriteBoolean	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		int	Val
	)

Функция записывает в ini-файл значение переменной как логическое.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
Val	Значение, которое требуется записать.

◆ iniFileWriteCoords()

void iniFileWriteCoords	(	INI_FILE	iniFile,
		const char *	section,
		const char *	name,
		const iniCoords *	val
	)

Функция записывает пару координат в ini-файл.

Аргументы

iniFile	Указатель на открытый ini-файл.
section	Указатель на имя секции.
name	Указатель на имя переменной.
val	Указатель на записываемые данные.

◆ iniFileWriteFileBottomCommentLine()

STATUS iniFileWriteFileBottomCommentLine	(	INI_FILE	iniFileDesc,
		const char *	commentLine
	)

Добавить строку с комментарием к комментарию в конце файла.

Если комментарий уже существует, то строка будет добавлена в низ текущего комментария.

Аргументы

iniFileDesc	Идентификатор ini-файла.
commentLine	Добавляемая строка.

Возвращает: OK, если строка была добавлена, ERROR иначе.

Заметки: Если первым символом строки не будет символ начала комментария, то он будет добавлен автоматически.

◆ iniFileWriteFileTopCommentLine()

STATUS iniFileWriteFileTopCommentLine	(	INI_FILE	iniFileDesc,
		const char *	commentLine
	)

Добавить строку с комментарием к комментарию в начале файла.

Если комментарий уже существует, то строка будет добавлена в низ текущего комментария.

Аргументы

iniFileDesc	Идентификатор ini-файла.
commentLine	Добавляемая строка.

Возвращает: OK, если строка была добавлена, ERROR иначе.

Заметки: Если первым символом строки не будет символ начала комментария, то он будет добавлен автоматически.

◆ iniFileWriteHex()

void iniFileWriteHex	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		int	Val
	)

Функция записывает в ini-файл значение переменной как целое число в формате HEX.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
Val	Значение, которое требуется записать.

◆ iniFileWriteIntArray()

void iniFileWriteIntArray	(	INI_FILE	iniFile,
		const char *	section,
		const char *	name,
		const iniIntArray *	val
	)

Функция записывает массив целых чисел в ini-файл.

Аргументы

iniFile	Указатель на открытый ini-файл.
section	Указатель на имя секции.
name	Указатель на имя переменной.
val	Указатель на записываемые данные.

◆ iniFileWriteInteger()

void iniFileWriteInteger	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		int	Val
	)

Функция записывает в ini-файл значение переменной как целое число.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
Val	Значение, которое требуется записать.

◆ iniFileWriteItemCommentLine()

STATUS iniFileWriteItemCommentLine	(	INI_FILE	iniFileDesc,
		const char *	sectionName,
		const char *	itemName,
		const char *	commentLine
	)

Добавить строку с комментарием к комментарию параметра.

Если комментарий уже существует, то строка будет добавлена в низ текущего комментария. Если параметра или секции не существует, то они будут созданы. Значение параметра будет пустым.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции, в которой расположен параметр.
itemName	Название параметра.
commentLine	Добавляемая строка.

Возвращает: OK, если строка была добавлена, ERROR иначе.

Заметки: Если первым символом строки не будет символ начала комментария, то он будет добавлен автоматически.

◆ iniFileWriteSectionCommentLine()

STATUS iniFileWriteSectionCommentLine	(	INI_FILE	iniFileDesc,
		const char *	sectionName,
		const char *	commentLine
	)

Добавить строку с комментарием к комментарию секции.

Если комментарий уже существует, то строка будет добавлена в низ текущего комментария. Если секции не существует, то она будут создана.

Аргументы

iniFileDesc	Идентификатор ini-файла.
sectionName	Название секции.
commentLine	Добавляемая строка.

Возвращает: OK, если строка была добавлена, ERROR иначе.

Заметки: Если первым символом строки не будет символ начала комментария, то он будет добавлен автоматически.

◆ iniFileWriteString()

void iniFileWriteString	(	INI_FILE	IF,
		const char *	Section,
		const char *	Name,
		const char *	Val
	)

Функция записывает в ini-файл значение переменной как строку символов.

Аргументы

IF	Указатель на открытый ini-файл.
Section	Указатель на имя секции.
Name	Указатель на имя переменной.
Val	Указатель на строку, которую требуется записать.

◆ iniFileWriteTextRect()

void iniFileWriteTextRect	(	INI_FILE	iniFile,
		const char *	section,
		const char *	name,
		const iniRect *	val
	)

Функция записывает данные о прямоугольной области в ini-файл.

Аргументы

iniFile	Указатель на открытый ini-файл.
section	Указатель на имя секции.
name	Указатель на имя переменной.
val	Указатель на записываемые данные.

Структуры данных

Определения типов

Работа с ini-файлом

Общие функции работы с содержимым файла

Функции для работы с коментариями к файлу, секциям и пунктам.

Целые числа

Целые числа в hex-формате

Логическое значение

Строки

Прямоугольные области

Пары координат

Массивы целых чисел

Массивы бинарных данных.

Подробное описание

Типы

◆ INI_FILE

Функции

◆ iniFileChangeName()

◆ iniFileCheckIfItemExists()

◆ iniFileCheckIfSectionExists()

◆ iniFileClose()

◆ iniFileCreate()

◆ iniFileDeleteFileBottomComment()

◆ iniFileDeleteFileTopComment()

◆ iniFileDeleteItem()

◆ iniFileDeleteItemComment()

◆ iniFileDeleteSection()

◆ iniFileDeleteSectionComment()

◆ iniFileFlush()

◆ iniFileFree()

◆ iniFileGetFileBottomComment()

◆ iniFileGetFileTopComment()

◆ iniFileGetItemComment()

◆ iniFileGetSectionComment()

◆ iniFileItemName()

◆ iniFileOpen()

◆ iniFilePrint()

◆ iniFileReadBinaryArray()

◆ iniFileReadBoolean()

◆ iniFileReadConstString()

◆ iniFileReadCoords()

◆ iniFileReadHex()

◆ iniFileReadIntArray()

◆ iniFileReadInteger()

◆ iniFileReadString()

◆ iniFileReadTextRect()

◆ iniFileRenameItem()

◆ iniFileRenameSection()

◆ iniFileSectionName()

◆ iniFileWriteBinaryArray()

◆ iniFileWriteBoolean()

◆ iniFileWriteCoords()

◆ iniFileWriteFileBottomCommentLine()

◆ iniFileWriteFileTopCommentLine()

◆ iniFileWriteHex()

◆ iniFileWriteIntArray()

◆ iniFileWriteInteger()

◆ iniFileWriteItemCommentLine()

◆ iniFileWriteSectionCommentLine()

◆ iniFileWriteString()

◆ iniFileWriteTextRect()