gobj_hsdata2()

gobj_hsdata2()#

Retrieves the structured data (hsdata) associated with a given hgobj, including inherited attributes from bottom objects.

Prototype

json_t *gobj_hsdata2(
    hgobj gobj, 
    const char *name, 
    BOOL verbose
);

Parameters

Key

Type

Description

gobj

hgobj

The hgobj whose structured data is to be retrieved.

name

const char *

The name of the attribute to retrieve from the structured data.

verbose

BOOL

If TRUE, logs an error message when the attribute is not found.


Return Value

A pointer to a json_t object containing the structured data of the given hgobj. Returns NULL if the attribute is not found.

Notes

This function traverses the bottom hierarchy of the hgobj to find the requested attribute. If verbose is TRUE, an error message is logged when the attribute is missing.

Prototype

// Not applicable in JS

Prototype

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