--- libaitcfg/inc/aitcfg.h 2012/04/02 14:39:02 1.6.4.1 +++ libaitcfg/inc/aitcfg.h 2012/04/02 16:00:00 1.6.4.4 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitcfg.h,v 1.6.4.1 2012/04/02 14:39:02 misho Exp $ +* $Id: aitcfg.h,v 1.6.4.4 2012/04/02 16:00:00 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -168,7 +168,7 @@ int MergeConfig(sl_config * __restrict cfg, sl_config * @cfg = Config root * @csSec = Config section //[{csSec}] * @csAttr = Config attribute //{csAttr} = ... - * return: 0 not found item; -1 error: null parameters; >0 position in list + * return: 0 not found item, -1 error or >0 position in list */ inline int cfg_findAttribute(cfg_root_t * __restrict cfg, const char *csSec, const char *csAttr); @@ -178,51 +178,44 @@ inline int cfg_findAttribute(cfg_root_t * __restrict c * @cfg = Config root * @csSec = Config section //[{csSec}], if NULL unset in *default* section * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute - * return: NULL item not found or null parameters; !=NULL value const string + * return: NULL item not found or null parameters, !=NULL value const string */ inline const char *cfg_getAttribute(cfg_root_t * __restrict cfg, const char *csSec, const char *csAttr); - -#if 0 /* - * cfg_SetAttribute() Set item in config list or add new item if not exists - * @cfg = Head list element + * cfg_setAttribute() - Set item in config or adding new item if not exists + * + * @cfg = Config root * @csSec = Config section //[{csSec}], if NULL set in *default* section - * @csAttr = Config attribute //{csAttr} = ..., if NULL set as *any* attribute + * @csAttr = Config attribute //{csAttr} = ... * @csVal = Config value //... = {csVal} to setup - * return: 0 nothing changed, -1 error: not enough memory; 1 find and update item; 2 added new item -*/ -int cfg_SetAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr, const u_char *csVal); + * return: 0 nothing changed, -1 error, 1 found and updated item or 2 added new item + */ +int cfg_setAttribute(cfg_root_t * __restrict cfg, const char *csSec, + const char *csAttr, const char *csVal); /* - * cfg_UnsetAttribute() Unset item from config list and free resources - * @cfg = Head list element + * cfg_unsetAttribute() - Unset item from config and free resources + * + * @cfg = Config root * @csSec = Config section //[{csSec}], if NULL unset in *default* section - * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute - * return: 0 item not found, -1 error: null parameters; >0 position in list -*/ -int cfg_UnsetAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr); -/* - * cfg_GetAttribute() Get item from config list and return his value - * @cfg = Head list element - * @csSec = Config section //[{csSec}], if NULL unset in *default* section - * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute - * return: NULL item not found or null parameters; !=NULL value const string -*/ -inline const u_char *cfg_GetAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr); + * @csAttr = Config attribute //{csAttr} = ... + * return: 0 item not found, -1 error or 1 removed item + */ +int cfg_unsetAttribute(cfg_root_t * __restrict cfg, const char *csSec, + const char *csAttr); /* - * cfg_LoadAttribute() Extended get attribute, if not found item return *default value* - * @cfg = Head list element + * cfg_loadAttribute() - Get guarded attribute, if not found item return *default value* + * + * @cfg = Config root * @csSec = Config section //[{csSec}], if NULL unset in *default* section - * @csAttr = Config attribute //{csAttr} = ..., if NULL unset as *any* attribute - * @psVal = Return buffer for item Value //... = {psVal} - * @ValLen = Length of buffer //{psVal} for return - * @csDefValue = *Default Value* for return in //{psVal}, if not found item in config list - * return: 0 item not found, -1 error: null parameters; >0 number of copied bytes in //{psVal} -*/ -int cfg_LoadAttribute(sl_config * __restrict cfg, const u_char *csSec, const u_char *csAttr, - u_char * __restrict psVal, int ValLen, const char *csDefValue); -#endif + * @csAttr = Config attribute //{csAttr} = ... + * @val = Return buffer for item Value //... = {val} + * @csDefValue = *Default Value* for return in //{val}, if not found item in config + * return: 0 item not found, -1 error or >0 number of copied bytes in //{val} + */ +int cfg_loadAttribute(cfg_root_t * __restrict cfg, const char *csSec, + const char *csAttr, ait_val_t * __restrict val, const char *csDefValue); #endif