summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_error.2
blob: 0e9d783c3c1714b00111c6f56f686ab5b2dcbbf5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
.TH "nvme_get_log_error" 9 "nvme_get_log_error" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_error \- Retrieve nvme error log
.SH SYNOPSIS
.B "int" nvme_get_log_error
.BI "(int fd "  ","
.BI "unsigned int nr_entries "  ","
.BI "bool rae "  ","
.BI "struct nvme_error_log_page *err_log "  ");"
.SH ARGUMENTS
.IP "fd" 12
File descriptor of nvme device
.IP "nr_entries" 12
Number of error log entries allocated
.IP "rae" 12
Retain asynchronous events
.IP "err_log" 12
Array of error logs of size 'entries'
.SH "DESCRIPTION"
This log page describes extended error information for a command that
completed with error, or may report an error that is not specific to a
particular command.
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.