Settings

Top  Previous  Next

 

These functions access or change program settings.  While the settings are actually contained within the database, these functions are separated for convenience in looking them up.

 

 

 

(Back to Function Types List)

 

 

 

Function:LockSetting        
Result-type:Boolean        
Arguments:cSection, cKey        
Description:Locks the global setting (actually its whole section) for upcoming changes, and returns TRUE if the lock was successful        

 

 

Function:LockSettingLocal        
Result-type:Boolean        
Arguments:cSection, cKey [, nWorkstaton]        
Description:Locks the local setting (actually its whole section) for upcoming changes, and returns TRUE if the lock was successful. If no workstation number is specified, uses the current workstation number        

 

 

Function:ReadAllSettings        
Result-type:Boolean        
Arguments:(none)        
Description:Reads all 'Setting' values , and refreshes the displays -- this is usually required after any SetSetting... functions in order for setting changes to actually take effect.        

 

 

Function:SetSettingBool        
Result-type:Boolean        
Arguments:cSection, cKey, bValue        
Description:Sets the boolean value for the given system global setting. Returns TRUE if successful. Note: You may need to use the ReadAllSettings() function (or restart the program) before the new settings take effect.        

 

 

Function:SetSettingLocalBool        
Result-type:Boolean        
Arguments:cSection, cKey, bValue [, nWorkstaton]        
Description:Sets the boolean value for the given system local setting. Returns TRUE if successful. If no workstation number is specified, uses the current workstation number. Note: You may need to use the ReadAllSettings() function (or restart the program) before the new settings take effect.        

 

 

Function:SetSettingLocalText        
Result-type:Boolean        
Arguments:cSection, cKey, cValue [, nWorkstaton]        
Description:Sets the text value for the given system local setting. Returns TRUE if successful. If no workstation number is specified, uses the current workstation number. Note: You may need to use the ReadAllSettings() function (or restart the program) before the new settings take effect.        

 

 

Function:SetSettingLocalTextEncrypted        
Result-type:Boolean        
Arguments:cSection, cKey, cValue [, nWorkstaton]        
Description:Sets the text value for the given system local setting, using encryption. Returns TRUE if successful. If no workstation number is specified, uses the current workstation number. Note: You may need to use the ReadAllSettings() function (or restart the program) before the new settings take effect.        

 

 

Function:SetSettingLocalValue        
Result-type:Boolean        
Arguments:cSection, cKey, nValue [, nWorkstaton]        
Description:Sets the numeric value for the given system local setting. Returns TRUE if successful. If no workstation number is specified, uses the current workstation number. Note: You may need to use the ReadAllSettings() function (or restart the program) before the new settings take effect.        

 

 

Function:SetSettingText        
Result-type:Boolean        
Arguments:cSection, cKey, cValue        
Description:Sets the text value for the given system global setting. Returns TRUE if successful. Note: You may need to use the ReadAllSettings() function (or restart the program) before the new settings take effect.        

 

 

Function:SetSettingTextEncrypted        
Result-type:Boolean        
Arguments:cSection, cKey, cValue        
Description:Sets the text value for the given system global setting, using encryption. Returns TRUE if successful. Note: You may need to use the ReadAllSettings() function (or restart the program) before the new settings take effect.        

 

 

Function:SetSettingValue        
Result-type:Boolean        
Arguments:cSection, cKey, nValue        
Description:Sets the numeric value for the given system global setting. Returns TRUE if successful. Note: You may need to use the ReadAllSettings() function (or restart the program) before the new settings take effect.        

 

 

Function:SettingBool        
Result-type:Boolean        
Arguments:cSection, cKey        
Description:Returns the boolean value for the given system global setting ('0' = FALSE, '1' = TRUE)        

 

 

Function:SettingIsEmpty        
Result-type:Boolean        
Arguments:cSection, cKey        
Description:Returns TRUE if the given system global setting is not found (which is different than a blank text setting value)        

 

 

Function:SettingLocalBool        
Result-type:Boolean        
Arguments:cSection, cKey [, nWorkstaton]        
Description:Returns the boolean value for the given system local setting specific to a workstation ('0' = FALSE, '1' = TRUE). If no workstation number is specified, uses the current workstation number        

 

 

Function:SettingLocalIsEmpty        
Result-type:Boolean        
Arguments:cSection, cKey [, nWorkstaton]        
Description:Returns TRUE if the given system local setting specific to a workstation is not found (which is different than a blank text setting value). If no workstation number is specified, uses the current workstation number        

 

 

Function:SettingLocalText        
Result-type:Text        
Arguments:cSection, cKey [, nWorkstaton]        
Description:Returns the text value for the given system local setting specific to a workstation. If no workstation number is specified, uses the current workstation number        

 

 

Function:SettingLocalTextEncrypted        
Result-type:Text        
Arguments:cSection, cKey [, nWorkstaton]        
Description:Returns the text value for the given encrypted system local setting specific to a workstation. If no workstation number is specified, uses the current workstation number        

 

 

Function:SettingLocalValue        
Result-type:Numeric        
Arguments:cSection, cKey [, nWorkstaton]        
Description:Returns the numeric value for the given system local setting specific to a workstation. If no workstation number is specified, uses the current workstation number        

 

 

Function:SettingText        
Result-type:Text        
Arguments:cSection, cKey        
Description:Returns the text value for the given system global setting        

 

 

Function:SettingTextEncrypted        
Result-type:Text        
Arguments:cSection, cKey        
Description:Returns the text value for the given encrypted system global setting        

 

 

Function:SettingValue        
Result-type:Numeric        
Arguments:cSection, cKey        
Description:Returns the numeric value for the given system global setting        

 

 

 

 

 

 


Page URL http://CampgroundMaster.com/help/settings.html

Campground Master Home