Config.GetString Method

ConfigGetString Method

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

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

Syntax

public virtual string GetString(
	string path,
	string default = null
)

abstract GetString : 
        path : string * 
        ?default : string 
(* Defaults:
        let _default = defaultArg default null
*)
-> string 
override GetString : 
        path : string * 
        ?default : string 
(* Defaults:
        let _default = defaultArg default null
*)
-> string

Parameters

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

Return Value

Type: String
The string 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