1()                         PMDK Programmer's Manual                         ()
2
3
4

NAME

6       pmempool_rm() - remove persistent memory pool
7

SYNOPSIS

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

DESCRIPTION

14       The  pmempool_rm()  function  removes the pool pointed to by path.  The
15       path can point to a regular file, device dax or pool set file.  If path
16       is  a  pool  set  file,  pmempool_rm()  will remove all part files from
17       replicas using unlink(2) before removing the pool set file itself.
18
19       The flags argument determines the behavior of pmempool_rm().  It is ei‐
20       ther 0 or the bitwise OR of one or more of the following flags:
21
22       • PMEMPOOL_RM_FORCE  -  Ignore all errors when removing part files from
23         replicas.
24
25       • PMEMPOOL_RM_POOLSET_LOCAL - Also remove local pool set file.
26

RETURN VALUE

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

SEE ALSO

32       unlink(3), libpmemlog(7), libpmemobj(7) and <https://pmem.io>
33
34
35
36PMDK -                            2023-06-05                                ()
Impressum