pmempool API version 1.3

The PMDK repository on GitHub is the ultimate source of information on PMDK from release 2.0! For all questions and to submit eventual issues please follow to that repository. The PMDK documentation collected here should be valid up to the 1.13.1 release but is maintained only on a best-effort basis and may not reflect the latest state of the art.

comment: <> (SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT) comment: <> (LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,) comment: <> (DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY) comment: <> (THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT) comment: <> ((INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE) comment: <> (OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.)

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
SEE ALSO

NAME

pmempool_rmU()/pmempool_rmW() - remove persistent memory pool

SYNOPSIS

#include <libpmempool.h>

int pmempool_rmU(const char *path, int flags);
int pmempool_rmW(const wchar_t *path, int flags);

NOTE: The PMDK API supports UNICODE. If the PMDK_UTF8_API macro is defined, basic API functions are expanded to the UTF-8 API with postfix U. Otherwise they are expanded to the UNICODE API with postfix W.

DESCRIPTION

The pmempool_rmU()/pmempool_rmW() 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_rmU()/pmempool_rmW() will remove all part files from local replicas using unlink(2) before removing the pool set file itself.

The flags argument determines the behavior of pmempool_rmU()/pmempool_rmW(). 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 local replicas.

  • PMEMPOOL_RM_POOLSET_LOCAL - Also remove local pool set file.

RETURN VALUE

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

SEE ALSO

rpmem_remove(3), unlink(3), libpmemlog(7), libpmemobj(7), librpmem(7) and http://pmem.io

The contents of this web site and the associated GitHub repositories are BSD-licensed open source.