sosFloatGet (Function)

sosFloatGet will retrieve the current value of a FLOAT object.

Please note that when using this function in a non-NX32L project, math.inc must be explicitly included by the application.

Input:

key : STRING

The key for the object to retrieve.

Note: Starting with runtime firmware V2.40.00, the key can be prefixed with "!" to access system objects.

Output:

value : FLOAT

The value of the object.

Returns: INT

Declaration:

FUNCTION sosFloatGet : INT;
VAR_INPUT
   key   : STRING;
   value : ACCESS FLOAT;
END_VAR;

Example:

INCLUDE rtcu.inc
INCLUDE math.inc
 
PROGRAM test;
VAR
   rc   : INT;
   temp : FLOAT;
END_VAR;
BEGIN
   ...
   // Create float object
   rc := sosFloatCreate(key := "config.max_temperature", value:=24.5, desc := "Largest temperature measured");
   DebugFmt(message:="sosFloatCreate=\1", v1:=rc);
   // Update float object
   rc:= sosFloatSet(key:="config.max_temperature", value:=26.7);
   DebugFmt(message:="sosFloatSet=\1", v1:=rc);
   
   // Read float object
   rc:= sosFloatGet(key:="config.max_temperature", value:=temp);
   DebugFmt(message:="sosFloatGet=\1 => " + floatToStr(v:=temp), v1:=rc);
   ...
END;
 
END_PROGRAM;