DataTree.ReadBool

Attempts to read boolean data from the specified key/value.

Declaration

[C++]
    bool ReadBool(char* Key, char* ValueName, bool DefValue, bool& Value);

[Pascal]
    function ReadBool(Key : string; ValueName : string; DefValue : boolean; var Value : boolean): Boolean;

[VB6]
    not applicable;

[ActiveX]
    not applicable;

[C#]
    public bool ReadBool(string Key, string ValueName, bool DefValue, ref bool Value);

[VB.NET]
    Public Function ReadBool(ByVal Key As String, ByVal ValueName As String, ByVal DefValue As Boolean, ByRef Value As Boolean) As Boolean

[Java]
    public boolean ReadBool(String Key, String ValueName, boolean DefValue, Boolean Value);

[Java ME]
    public boolean ReadBool(String Key, String ValueName, boolean DefValue, Boolean Value);

[Palm]
    bool ReadBool(char* Key, char* ValueName, bool DefValue, bool& Value);

[DLL]
    not applicable;

Parameters

• Key - key name. For more information look here.
• ValueName - value name. For more information look here.
• DefValue - set here the value that will be returned on failure.
• Value - returns read value on success or DefValue on failure.

Return value

    True on success.
    False on failure.

Description

    Use this method to read boolean data from the specified key/value. Sets Value and returns True on success or sets Value to DefValue and returns False on failure.