1PMEMPOOL_RM(3)             PMDK Programmer's Manual             PMEMPOOL_RM(3)
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 local
17       replicas using unlink(2), and all remote replicas using rpmem_remove(3)
18       (see librpmem(7)), before removing the pool set file itself.
19
20       The flags argument determines the behavior of pmempool_rm().  It is ei‐
21       ther 0 or the bitwise OR of one or more of the following flags:
22
23       • PMEMPOOL_RM_FORCE - Ignore all errors when removing part  files  from
24         local or remote replicas.
25
26       • PMEMPOOL_RM_POOLSET_LOCAL - Also remove local pool set file.
27
28       • PMEMPOOL_RM_POOLSET_REMOTE - Also remove remote pool set file.
29

RETURN VALUE

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

SEE ALSO

35       rpmem_remove(3), unlink(3), libpmemlog(7),  libpmemobj(7),  librpmem(7)
36       and <https://pmem.io>
37
38
39
40PMDK - pmempool API version 1.3   2020-10-28                    PMEMPOOL_RM(3)