gobj_treedbs()

gobj_treedbs()#

Retrieves a list of TreeDB names available in the given hgobj.

Prototype

json_t *gobj_treedbs(
    hgobj gobj,
    json_t *kw,
    hgobj src
);

Parameters

Key

Type

Description

gobj

hgobj

The hgobj instance from which to retrieve the TreeDB names.

kw

json_t *

A JSON object containing additional options for filtering the TreeDB list. Owned by the function.

src

hgobj

The source hgobj requesting the TreeDB list.


Return Value

A JSON array containing the names of available TreeDBs. Returns NULL if an error occurs.

Notes

If the gobj does not implement mt_treedbs, an error is logged and NULL is returned.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples