etienne herbin / FileIni
Embed: (wiki syntax)

« Back to documentation index

INI Struct Reference

INI Struct Reference

A structure that represent a section node. More...

#include <FileIni.h>

Public Member Functions

LPINI IniLoad (char *ptrFileName)
LPINI IniGetSection (char *ptrSectionName, LPINI lpinIni)
LPINIKEY IniGetKey (char *ptrVarName, LPINI lpinSection)
 Gets a pointer to a key.

Detailed Description

A structure that represent a section node.

Definition at line 25 of file FileIni.h.


Member Function Documentation

LPINIKEY IniGetKey ( char *  ptrVarName,
LPINI  lpinSection 
)

Gets a pointer to a key.

Parameters:
[in]ptrVarNameA pointer to a NULL-terminated string that stores the name of the needed key.
[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 needed key. If a error occurs, the return value is NULL.

Definition at line 103 of file FileIni.c.

LPINI IniGetSection ( char *  ptrSectionName,
LPINI  lpinIni 
)

Gets a pointer to a section.

Parameters:
ptrSectionFileA pointer to a NULL-terminated string that stores the name of the needed section.
lpinIniA pointer to an INI structure created with IniLoad().
Returns:
Returns a pointer to an INI structure that represents the needed section. If a error occurs, the return value is NULL.

Definition at line 90 of file FileIni.c.

LPINI IniLoad ( char *  ptrFileName )

Loads and parses an Ini file into memory.

Parameters:
ptrFileA pointer to a NULL-terminated string that contains the name of the file to load. If this parameters is NULL, the function create a void Ini file in memory.
Returns:
Returns a pointer to an INI structure that represents the loaded file. If a error occurs, the return value is NULL.

Definition at line 19 of file FileIni.c.