[This is preliminary documentation and is subject to change.]

Attempts to parse a given key's value as a boolean.

Namespace: fCraft
Assembly: fCraft (in fCraft.dll) Version: 0.6.2.4 (0.6.2.4)

Syntax

   
 C# 
public static bool TryGetBool(
	this ConfigKey key,
	out bool result
)

Parameters

key
ConfigKey
ConfigKey to get value from.
result
Boolean%
Will be set to the value on success, or to false on failure.

Return Value

Whether parsing succeeded.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConfigKey. When you use instance method syntax to call this method, omit the first parameter.

See Also