PMEMSET_REMOVE_PART_MAP(3)

NAME

pmemset_remove_part_map() - removes part mapping from the pmemset

SYNOPSIS

    #include <libpmemset.h>
    struct pmemset;
    struct pmemset_part_map;
    int pmemset_remove_part_map(struct pmemset *set,
            struct pmemset_part_map **pmap_ptr);

DESCRIPTION

The pmemset_remove_part_map() function removes provided part mapping from the pmemset. Mapping to be removed can be retrieved using either pmemset_first_part_map(3), pmemset_next_part_map(3) or pmemset_part_map_by_address(3) functions. Provided part mapping can't be referenced more than once for this function to succeed. Reference to the previously retrieved part mapping can be dropped using pmemset_part_map_drop(3) function.

Note that a retrieved part mapping could be coalesced from multiple parts therefore removing it also removes each part making up this part mapping. For more information see pmemset_set_contiguous_part_coalescing(3) and pmemset_part_map(3).

When the pmemset_remove_part_map() function succeeds it the part mapping and sets the pointer passed via pmap_ptr variable to NULL.

RETURN VALUE

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

ERRORS

The pmemset_remove_part_map() can fail with the following errors:

•   PMEMSET_E_PART_NOT_FOUND - provided part wasn't found in the pmemset

SEE ALSO

pmemset_first_part_map(3), pmemset_next_part_map(3), pmemset_part_map(3), pmemset_part_map_by_address(3), pmemset_part_map_drop(3) pmemset_set_contiguous_part_coalescing(3), libpmemset(7) and <http://pmem.io>