gobj_get_resource()

Retrieves a resource from the specified hgobj object, using the given resource name and filter criteria.

C

Prototype

json_t *gobj_get_resource(
    hgobj gobj,
    const char *resource,
    json_t *jn_filter,
    json_t *jn_options
);

Parameters

Key	Type	Description
gobj	hgobj	The hgobj instance from which the resource is retrieved.
resource	const char *	The name of the resource to retrieve.
jn_filter	json_t *	A JSON object containing filter criteria for selecting the resource. Owned by the caller.
jn_options	json_t *	A JSON object containing additional options for retrieving the resource. Owned by the caller.

---

Return Value

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

Notes

If the gobj is NULL or destroyed, an error is logged and NULL is returned. If the mt_get_resource method is not defined in the hgobj’s gclass, an error is logged and NULL is returned.

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