etienne herbin / FileIni

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

FileIni.h File Reference
Data Structures | Functions

FileIni.h File Reference

Go to the source code of this file.

Data Structures

struct  INIKEY
 A structure that stores a configuration key node. More...
struct  INI
 A structure that represent a section node. More...

Functions

int _strupr (char *ptrSource)
 Sets string characters to upper case.
LPINIKEY IniCreateKey (char *ptrKeyName, char *ptrValue, LPINI lpinSection)
 Creates a key.
LPINI IniCreateSection (char *ptrSectionName, LPINI lpinIni)
 Creates a section.
int IniSave (char *ptrFileName, LPINI lpinIni)
 Saves an Ini file .
void IniDeleteSection (LPINI lpinSection)
 Deletes a section.
void IniDeleteKey (LPINIKEY lpikKey)
 Deletes a key.
void IniFree (LPINI lpinIni)
 Frees an Ini file.

Detailed Description

Definition in file FileIni.h.

Function Documentation

int _strupr ( char *  ptrSource )

Sets string characters to upper case.

Parameters:
ptrSourceA pointer to the string to transform to upper case.

Definition at line 6 of file FileIni.c.

LPINIKEY IniCreateKey ( char *  ptrKeyName,
char *  ptrValue,
LPINI  lpinSection 
)

Creates a key.

Parameters:
[in]ptrKeyNameA pointer to a NULL-terminated string that stores the name of the key to be created.
[in]ptrValueThe length of the NULL-terminated string that stores the value of the key to be created.
[in]lpinSectionA pointer to an INI structure that represents a section (opened with IniGetSection() or IniCreateSection()).
Returns:
Returns a pointer to an INIKEY structure that represents the created key. If a error occurs, the return value is NULL.

Definition at line 135 of file FileIni.c.

LPINI IniCreateSection ( char *  ptrSectionName,
LPINI  lpinIni 
)

Creates a section.

Parameters:
[in]ptrSectionNameA pointer to a NULL-terminated string that stores the name of the section to be created.
[in]lpinIniA pointer to an INI structure that represents a file (opened with IniLoad()).
Returns:
Returns a pointer to an INI structure that represents the created section. If a error occurs, the return value is NULL.

Definition at line 160 of file FileIni.c.

void IniDeleteKey ( LPINIKEY  lpikKey )

Deletes a key.

Parameters:
[in]lpinSectionA pointer to an INI structure that represents the key to be deleted (opened with IniGetKey() or IniCreateKey()).
Returns:
No return value avaliable.

Definition at line 211 of file FileIni.c.

void IniDeleteSection ( LPINI  lpinSection )

Deletes a section.

Parameters:
[in]lpinSectionA pointer to an INI structure that represents the section to be deleted (opened with IniGetSection() or IniCreateSection()).
Returns:
No return value avaliable.

Definition at line 205 of file FileIni.c.

void IniFree ( LPINI  lpinIni )

Frees an Ini file.

Parameters:
[in]lpinIniA pointer to an INI structure that represents the file (opened with IniLoad()) to be freed.
Returns:
No return value avaliable.

Definition at line 217 of file FileIni.c.

int IniSave ( char *  ptrFileName,
LPINI  lpinIni 
)

Saves an Ini file .

Parameters:
[in]ptrFileNameA pointer to a NULL-terminated string that stores the name of the file to be saved.
[in]lpinIniA pointer to an INI structure that represents a file (opened with IniLoad()). 0 if no error occurs, 1 else.

Definition at line 181 of file FileIni.c.

Generated on Sat Jul 16 2022 22:00:53 by  doxygen 1.7.2