gobj_read_bool_attr()

The function gobj_read_bool_attr() retrieves the boolean value of a specified attribute from a given hgobj. It traverses the object’s hierarchy to find the attribute if it is not directly present in the object.

C

Prototype

BOOL gobj_read_bool_attr(
    hgobj gobj,
    const char *name
);

Parameters

Key	Type	Description
gobj	hgobj	The hgobj instance from which the attribute is read.
name	const char *	The name of the attribute to retrieve.

---

Return Value

Returns TRUE if the attribute is set to a boolean true value, FALSE otherwise.

Notes

If the attribute is not found, a warning is logged, and FALSE is returned. If the object has a mt_reading method, it is invoked before returning the attribute value.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples