Config.GetBoolean Method

ConfigGetBoolean Method

Retrieves a boolean 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 bool GetBoolean(
	string path,
	bool default = false
)

abstract GetBoolean : 
        path : string * 
        ?default : bool 
(* Defaults:
        let _default = defaultArg default false
*)
-> bool 
override GetBoolean : 
        path : string * 
        ?default : bool 
(* Defaults:
        let _default = defaultArg default false
*)
-> bool

Parameters

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

Return Value

Type: Boolean
The boolean 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