From 1728a83539def6fb12fd5243661cc9adc80f3a3a Mon Sep 17 00:00:00 2001 From: kevin Date: Tue, 16 Apr 2013 07:46:55 -0700 Subject: [PATCH] cmPrefs.h: Update comments --- cmPrefs.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cmPrefs.h b/cmPrefs.h index 03fde8c..2f048ad 100644 --- a/cmPrefs.h +++ b/cmPrefs.h @@ -41,6 +41,9 @@ extern "C" { // Set 'fnName' to NULL to use cmFsAppName() as the pref file name. // Set 'fnExt' to NULL to use '.js' as the pref file extension. // 'cbFunc' and 'cbDataPtr' are optional in both versions. + // 'pathPrefixStr' (optional) provides a prefix to be added to + // the path of each preference variable. This can be used to separate + // preference data from other data in the preference file. cmPrRC_t cmPrefsInit( cmCtx_t* ctx, cmPrH_t* hp, const cmChar_t* fnName, const cmChar_t* fnExt, cmPrefsOnChangeFunc_t cbFunc, void* cbDataPtr, const cmChar_t* pathPrefixStr ); cmPrRC_t cmPrefsInitialize( cmCtx_t* ctx, cmPrH_t* hp, const cmChar_t* fn, cmPrefsOnChangeFunc_t cbFunc, void* cbDataPtr, const cmChar_t* pathPrefixStr); cmPrRC_t cmPrefsFinalize( cmPrH_t* hp );