cmap_delete(3)

cmap_delete3

Delete key/value pair from the cmap service

Usage

#include <corosync/cmap.h>

cs_error_t cmap_delete(cmap_handle_t handle, const char *key_name);

Overview

The cmap_delete function is used to delete key from cmap. Key must be previously created by cmap_set(3) function. The handle argument is connection to CMAP database obtained by calling cmap_initialize(3) function. key_name is name of key to delete.

Return value

This call returns the CS_OK value if successful. If key_name is unspecified, CS_ERR_INVALID_PARAM is returned. For nonexisting keys, CS_ERR_NOT_EXIST error is returned. Some of keys may be tagged read-only directly in corosync and deleting such key will result in CS_ERR_ACCESS error.

Releases

5 releases since Debian 9 (Stretch); the text changed 1 time.

  1. 9
  2. 10–13

From libcmap-dev 3.1.9-2+deb13u1 in Debian 13 (Trixie). Parsed by carta from the page's man source.