gobj_list_snaps()

gobj_list_snaps()#

Retrieves a list of snapshots associated with the given hgobj.

Prototype

json_t *gobj_list_snaps(
    hgobj gobj,
    json_t *filter,
    hgobj src
);

Parameters

Key

Type

Description

gobj

hgobj

The hgobj instance from which to retrieve the snapshots.

filter

json_t *

A JSON object containing filter criteria for the snapshots. Owned by the caller.

src

hgobj

The source hgobj requesting the snapshot list.


Return Value

A JSON array containing the list of snapshots. The caller must decrement the reference count when done.

Notes

If gobj is NULL or destroyed, 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