pmempool_rm(3)

pmempool_rm3

Remove persistent memory pool

Usage

#include <libpmempool.h>
int pmempool_rm(const char *path, int flags);

Overview

The pmempool_rm() function removes the pool pointed to by path. The path can point to a regular file, device dax or pool set file. If path is a pool set file, pmempool_rm() will remove all part files from replicas using unlink(2) before removing the pool set file itself.

The flags argument determines the behavior of pmempool_rm(). It is either 0 or the bitwise OR of one or more of the following flags:

•

PMEMPOOL_RM_FORCE - Ignore all errors when removing part files from replicas.

•

PMEMPOOL_RM_POOLSET_LOCAL - Also remove local pool set file.

Return value

On success, pmempool_rm() returns 0. On error, it returns -1 and sets errno accordingly.

Releases

4 releases since Debian 10 (Buster); the text changed 3 times.

  1. 10
  2. 11
  3. 12
  4. 13

From libpmempool-dev 1.13.1-1.1+b1 in Debian 13 (Trixie). Parsed by carta from the page's man source.