Delete a parameter.

DWORD CfgParDelete(
    CFGFILE cFile,

    LPCSTR  szSection,

    LPCSTR  szPar
); 

Parameters

cFile

(in) File handle retrieved by previous CfgFileOpen with argument CFG_SECTION as type.

szSection

(in) Name of section in which the parameter is searched.

szPar

(in) Name of parameter to be deleted.

Return values

ECFG_OK for success or an error code on failure.

Remarks

Deletes the parameter with its value and comment form its section.

Errors

ECFG_BADCFGFILE

File handle out of range or invalid

ECFG_NOTFOUND

Section name not found

ECFG_NOTFOUND2

Parameter name not found

ECFG_WRONGFILETYPE

Wrong file type