Quellcode durchsuchen

cmPrefs.h: Update comments

master
kevin vor 11 Jahren
Ursprung
Commit
1728a83539
1 geänderte Dateien mit 3 neuen und 0 gelöschten Zeilen
  1. 3
    0
      cmPrefs.h

+ 3
- 0
cmPrefs.h Datei anzeigen

@@ -41,6 +41,9 @@ extern "C" {
41 41
   // Set 'fnName' to NULL to use cmFsAppName() as the pref file name.
42 42
   // Set 'fnExt' to NULL to use '.js' as the pref file extension.
43 43
   // 'cbFunc'  and 'cbDataPtr' are optional in both versions.
44
+  // 'pathPrefixStr' (optional) provides a prefix to be added to 
45
+  // the path of each preference variable. This can be used to separate
46
+  // preference data from other data in the preference file.
44 47
   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 );
45 48
   cmPrRC_t cmPrefsInitialize( cmCtx_t* ctx, cmPrH_t* hp, const cmChar_t* fn, cmPrefsOnChangeFunc_t cbFunc, void* cbDataPtr, const cmChar_t* pathPrefixStr);
46 49
   cmPrRC_t cmPrefsFinalize(   cmPrH_t* hp );

Laden…
Abbrechen
Speichern