summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_sanitize.2
blob: 261bf1b2cbd763f26ee55aa352517dbaf85bf8c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.TH "nvme_get_log_sanitize" 9 "nvme_get_log_sanitize" "February 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_sanitize \- Retrieve Sanitize Status
.SH SYNOPSIS
.B "int" nvme_get_log_sanitize
.BI "(int fd "  ","
.BI "bool rae "  ","
.BI "struct nvme_sanitize_log_page *log "  ");"
.SH ARGUMENTS
.IP "fd" 12
File descriptor of nvme device
.IP "rae" 12
Retain asynchronous events
.IP "log" 12
User address to store the sanitize log
.SH "DESCRIPTION"
The Sanitize Status log page reports sanitize operation time estimates and
information about the most recent sanitize operation.
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.