gobj_read_user_data()

Retrieves user-defined data associated with the given hgobj. If a specific key is provided, it returns the corresponding value; otherwise, it returns the entire user data dictionary.

C

Prototype

json_t *gobj_read_user_data(
    hgobj gobj,
    const char *name
);

Parameters

Key	Type	Description
gobj	hgobj	The hgobj instance from which to retrieve user data.
name	const char *	The key of the user data to retrieve. If NULL or empty, the entire user data dictionary is returned.

---

Return Value

A JSON object containing the requested user data. If name is specified, the corresponding value is returned. If name is NULL or empty, the entire user data dictionary is returned. Returns NULL if gobj is NULL.

Notes

The returned JSON object is not owned by the caller and should not be modified or freed.

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