etienne herbin / FileIni
Embed: (wiki syntax)

« Back to documentation index

INIKEY Struct Reference

INIKEY Struct Reference

A structure that stores a configuration key node. More...

#include <FileIni.h>

Public Member Functions

int IniGetValue (char *ptrValue, int iLength, LPINIKEY lpikIniKey)
 Gets a key value.
int IniSetValue (char *ptrValue, LPINIKEY lpikIniKey)
 Sets a key value.

Detailed Description

A structure that stores a configuration key node.

Definition at line 14 of file FileIni.h.


Member Function Documentation

int IniGetValue ( char *  ptrValue,
int  iLength,
LPINIKEY  lpikIniKey 
)

Gets a key value.

Parameters:
[out]ptrValueA pointer to a buffer that will receive the key content.
[in]iLenghtThe length of the buffer pointed by ptrValue.
[in]lpikIniKeyA pointer to an INIKEY structure that represents a key (opened with IniGetKey() or IniCreateKey()).
Returns:
Returns 0 if no error occurs, 1 else.

Definition at line 117 of file FileIni.c.

int IniSetValue ( char *  ptrValue,
LPINIKEY  lpikIniKey 
)

Sets a key value.

Parameters:
[in]ptrValueA pointer to a NULL-terminated string that stores the value to be set.
[in]lpikIniKeyA pointer to an INIKEY structure that represents a key (opened with IniGetKey() or IniCreateKey()).
Returns:
Returns 0 if no error occurs, 1 else.

Definition at line 124 of file FileIni.c.