INtime SDK Help
CfgParSetComment

Set parameter comment.

DWORD Cfg(
CFGFILE cFile,
    LPCSTR  szSection,
    LPCSTR  szPar,
    LPCSTR  szComment
); 

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.
szComment
(in) The comment. A single semicolon is written in front of the comment when saving the file.

Return values

ECFG_OK for success or an error code on failure.

Remarks

Set the comment for a section/parameter.

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
See Also