pmemset API version 1.0

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.

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
SEE ALSO

NAME

pmemset_config_new(), pmemset_config_delete() - allocate and free a configuration structure for a pmemset object

SYNOPSIS

#include <libpmemset.h>

struct pmemset_config;
int pmemset_config_new(struct pmemset_config **cfg);
int pmemset_config_delete(struct pmemset_config **cfg);

DESCRIPTION

The pmemset_config_new() function instantiates a new (opaque) configuration structure, pmemset_config, which is used to define set parameters for a pmemset_new(3) function, and returns it through the pointer in *cfg.

The pmemset_config_delete() function frees *cfg returned by pmemset_config_new() and sets *cfg to NULL. If *cfg is NULL, no operation is performed.

RETURN VALUE

The pmemset_config_new() function returns 0 on success or a negative error code on failure. pmemset_config_new() does set *cfg to NULL on failure.

The pmemset_config_delete() function always returns 0.

ERRORS

pmemset_config_new() can fail with the following error:

  • -ENOMEM - out of memory

SEE ALSO

errno(3), pmemset_new(3), libpmemset(7) and http://pmem.io

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