Config.GetFloat Method

ConfigGetFloat Method

Retrieves a float value from the specified path in the configuration.

Namespace: Akka.Configuration
Assembly: Akka (in Akka.dll) Version: 1.2.3.129 (1.2.3.129)

Syntax

public virtual float GetFloat(
	string path,
	float default = 0f
)

abstract GetFloat : 
        path : string * 
        ?default : float32 
(* Defaults:
        let _default = defaultArg default 0f
*)
-> float32 
override GetFloat : 
        path : string * 
        ?default : float32 
(* Defaults:
        let _default = defaultArg default 0f
*)
-> float32

Parameters

path: Type: SystemString
The path that contains the value to retrieve.
default (Optional): Type: SystemSingle
The default value to return if the value doesn't exist.

Return Value

Type: Single
The float value defined in the specified path.

Exceptions

Exception	Condition
InvalidOperationException	This exception is thrown if the current node is undefined.

Reference

Config Class

Akka.Configuration Namespace