confdb_object_destroy(3)

confdb_object_destroy3

Remove an object from the configuration database

Usage

#include <corosync/confdb.h>

confdb_error_t confdb_destroy(confdb_handle_t handle, unsigned int object_handle);

Overview

The confdb_object_destroy call removes an object from the configuration database. It also remove all subkeys and all subobjects in the database, so be VERY CAREFUL!. The input value object_handle is the handle of the object to remove, this can be got from the confdb_object_find or confdb_object_iter calls or confdb_object_create calls.

Return value

This call returns the CONFDB_OK value if successful, otherwise an error is returned.

Errors

The errors are undocumented.

Releases

4 releases since Debian 5.0 (Lenny); the text changed 1 time.

  1. 5.0
  2. 6.0–8

From corosync-dev 1.4.6-1.1 in Debian 8 (Jessie). Parsed by carta from the page's man source.