objects: add bt_object_array_set()

[babeltrace.git] / include / babeltrace / objects.h

diff --git a/include/babeltrace/objects.h b/include/babeltrace/objects.h
index 325afe83dfe7fca6e4396000b779863d63525214..f030424f283d6ead079eb999a2af4726746308df 100644 (file)
--- a/include/babeltrace/objects.h
+++ b/include/babeltrace/objects.h
@@ -651,6 +651,23 @@ extern int bt_object_array_append_array(struct bt_object *array_obj);
  */
 extern int bt_object_array_append_map(struct bt_object *array_obj);
 
+/**
+ * Replaces the element object at index \p index of the array object
+ * \p array_obj by \p element_obj.
+ *
+ * The replaced object's reference count is decremented, unless it's
+ * a null object. The reference count of \p element_obj is incremented,
+ * unless it's a null object.
+ *
+ * @param array_obj    Array object
+ * @param index                Index of element object to replace
+ * @param element_obj  New element object at position \p index of
+ *                     \p array_obj
+ * @returns            0 on success, or a negative value on error
+ */
+extern int bt_object_array_set(struct bt_object *array_obj, size_t index,
+       struct bt_object *element_obj);
+
 /**
  * Gets the size of a map object, that is, the number of elements
  * contained in a map object.