.\" Automatically generated by Pandoc 2.10.1
.\"
.TH "PMEMBLK_SET_ZERO" "3" "2020-10-28" "PMDK - pmemblk API version 1.1" "PMDK Programmer's Manual"
.hy
.\" SPDX-License-Identifier: BSD-3-Clause
.\" Copyright 2017-2018, Intel Corporation
.SH NAME
.PP
\f[B]pmemblk_set_zero\f[R](), \f[B]pmemblk_set_error\f[R]() - block
management functions
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <libpmemblk.h>

int pmemblk_set_zero(PMEMblkpool *pbp, long long blockno);
int pmemblk_set_error(PMEMblkpool *pbp, long long blockno);
\f[R]
.fi
.SH DESCRIPTION
.PP
The \f[B]pmemblk_set_zero\f[R]() function writes zeros to block number
\f[I]blockno\f[R] in persistent memory resident array of blocks
\f[I]pbp\f[R].
Using this function is faster than actually writing a block of zeros
since \f[B]libpmemblk\f[R](7) uses metadata to indicate the block should
read back as zero.
.PP
The \f[B]pmemblk_set_error\f[R]() function sets the error state for
block number \f[I]blockno\f[R] in persistent memory resident array of
blocks \f[I]pbp\f[R].
A block in the error state returns \f[I]errno\f[R] \f[B]EIO\f[R] when
read.
Writing the block clears the error state and returns the block to normal
use.
.SH RETURN VALUE
.PP
On success, \f[B]pmemblk_set_zero\f[R]() and
\f[B]pmemblk_set_error\f[R]() return 0.
On error, they return -1 and set \f[I]errno\f[R] appropriately.
.SH SEE ALSO
.PP
\f[B]libpmemblk\f[R](7) and \f[B]<https://pmem.io>\f[R]