Skip to main content
Version: 10.7.x

bfgSettings Class

Static Public Member Functions

static bool getBoolean (string key, bool withDefault)
 This version of the get() method lets the caller avoid having to do casting in order to get at the actual boolean value. More...
 
static double getDouble (string key, double withDefault)
 This version of the get() method lets the caller avoid having to do casting in order to get at the actual double value. More...
 
static int getInteger (string key, int withDefault)
 This version of the get() method lets the caller avoid having to do casting in order to get at the actual integer value. More...
 
static long getLong (string key, long withDefault)
 This version of the get() method lets the caller avoid having to do casting in order to get at the actual long value. More...
 
static string getString (string key, string withDefault)
 This version of the get() method lets the caller avoid having to do casting in order to get at the string value. More...
 

Member Function Documentation

◆ getBoolean()

static bool BFGSDK.bfgSettings.getBoolean (string key,
bool withDefault 
)
inlinestatic
This version of the get() method lets the caller avoid having to do casting in order to get at the actual boolean value.
Parameters
keyString whose associated object is to be returned.
withDefaultBoolean value to return if the key is not found.
Returns
Value as a primitive boolean. TRUE if boolean TRUE or Integer non-zero (e.g., 0/1 for FALSE/TRUE) NOTE: Integer 0/1 is supported for compatibility with older code that stored booleans as 0/1 integers.

◆ getDouble()

static double BFGSDK.bfgSettings.getDouble (string key,
double withDefault 
)
inlinestatic
This version of the get() method lets the caller avoid having to do casting in order to get at the actual double value.
Parameters
keyString whose associated object is to be returned.
withDefaultInteger value to return if the key is not found.
Returns
Value as a primitive double.

◆ getInteger()

static int BFGSDK.bfgSettings.getInteger (string key,
int withDefault 
)
inlinestatic
This version of the get() method lets the caller avoid having to do casting in order to get at the actual integer value.
Parameters
keyString whose associated object is to be returned.
withDefaultInteger value to return if the key is not found.
Returns
Value as a primitive integer.

◆ getLong()

static long BFGSDK.bfgSettings.getLong (string key,
long withDefault 
)
inlinestatic
This version of the get() method lets the caller avoid having to do casting in order to get at the actual long value.
Parameters
keyString whose associated object is to be returned.
withDefaultLong value to return if the key is not found.
Returns
Value as a primitive long.

◆ getString()

static string BFGSDK.bfgSettings.getString (string key,
string withDefault 
)
inlinestatic
This version of the get() method lets the caller avoid having to do casting in order to get at the string value.
Parameters
keyString whose associated object is to be returned.
withDefaultString to return if the key is not found.
Returns
Value as a string object or the withDefault value if it does not exist.