pmem2_map_delete - Man Page

deletes a mapping

Synopsis

#include <libpmem2.h>

int pmem2_map_delete(struct pmem2_map **map_ptr);

Description

The pmem2_map_delete() function deletes the mapping described by the struct pmem2_map object.

If pmem2_map_delete() succeeds in deleting the mapping, it releases the struct pmem2_map object describing it and writes a NULL value to map_ptr. If the function fails, the map_ptr variable and the map object itself are left unmodified and appropriate error value is returned. For a list of possible return values please see Return Value.

The pmem2_map_delete() function will not unmap mapping provided by the user by pmem2_map_from_existing() function. In such case it will only free struct pmem2_map object.

Return Value

The pmem2_map_delete() function returns 0 on success or a negative error code on failure.

Errors

The pmem2_map_delete() can fail with the following errors:

On systems other than Windows it can also return -EINVAL from the underlying munmap(2) function.

See Also

pmem2_map_new(3), libpmem2(7) and <http://pmem.io>

Referenced By

pmem2_map_from_existing(3), pmem2_map_new(3).

2020-10-28 PMDK - pmem2 API version 1.0 PMDK Programmer's Manual