GetFloat Method (String, Single)

IDataDictionary GetFloat Method (String, Single)

C# API

Returns a float value held in the dictionary, or the defaultValue if the key cannot be found.

Namespace: Facilita.Fc.Runtime
Assembly: fc_clr (in fc_clr.dll) Version: 9.5.7.98

Syntax

float GetFloat(
	string key,
	float defaultValue
)

float GetFloat(
	string key,
	float defaultValue
)

Parameters

key: Type: System String
The key to be looked up in the dictionary.

defaultValue: Type: System Single
The value to return if the key is not present in the dictionary.

Return Value

A float value held in the dictionary, or defaultValue if the key could not be found.

Remarks

Default data warning:

When called from a VU script, if the defaultValue is returned then a message is also written to the VU Event Log. This feature helps highlight problems with data bindings when data is expected to come from a data source, but the default value is returned instead.

An example of the message entry in the Event Log:

Type	ID	Info
Message	Default data warning	No value found for key: myFloat, using default value instead: 3.142F

To turn this feature off, go to the Test view in eggPlant Performance Studio and uncheck the option "Enable default data warnings" on the Data tab.