Get value for a setting.

DWORD Cfg(
    CFGFILE cFile,

    LPCSTR  keyword,

    LPCSTR  szDefault,

    int     n,

    LPSTR   pDest,

    int*    pLen
); 

Parameters

cFile

(in) File handle retrieved by previous CfgFileOpen with argument CFG_NET_EQUAL or CFG_NET_SPACE as type.

keyword

(in) The keyword for which the value should be found.

szDefault

(in) The value returned, if keyword is not in file.

n

(in) The nth occurrence of the keyword is searched.

pDest

(out) Pointer to buffer to receive the string. The buffer must be at least *pLen characters long. The terminating zero is stored in the buffer, so there must be space for that.

pLen

(in, out) Pointer to a variable that is set to the size of the buffer before the call. On successful return, the variable now contains the length of the value (including terminating zero).

Return values

ECFG_OK for success or an error code on failure.

Remarks

Retrieves the value following the nth occurrence of a given keyword and separator

Errors

ECFG_BADCFGFILE

File handle out of range or invalid

ECFG_LIMIT

Size of buffer too small.

ECFG_WRONGFILETYPE

Wrong file type