Scroll to navigation

PMEM2_CONFIG_SET_OFFSET(3) PMDK Programmer's Manual PMEM2_CONFIG_SET_OFFSET(3)

NAME

pmem2_config_set_offset() - set offset in the pmem2_config structure

SYNOPSIS


#include <libpmem2.h>
struct pmem2_config;
int pmem2_config_set_offset(struct pmem2_config *config, size_t offset);

    

DESCRIPTION

The pmem2_config_set_offset() function configures the offset which will be used to map the contents from the specified location of the source. *config should be already initialized, please see pmem2_config_new(3) for details. The must be a multiple of the alignment required for the config. The alignment requirements are specific to a data source. To retrieve the alignment required for specific instance of pmem2_source** use pmem2_source_alignment(3). By default, the offset is 0.

RETURN VALUE

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

ERRORS

The pmem2_config_set_offset() can fail with the following errors:
PMEM2_E_OFFSET_OUT_OF_RANGE - argument out of range, offset is greater than INT64_MAX

SEE ALSO

libpmem2(7), pmem2_source_alignment(3), pmem2_config_new(3), pmem2_map_new(3), sysconf(3) and <http://pmem.io>
2020-10-16 PMDK - pmem2 API version 1.0