summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_status_to_string.2
blob: ba26ae529b12e7eb82f0cef21c41d87325741fef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
.TH "nvme_mi_status_to_string" 9 "nvme_mi_status_to_string" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_mi_status_to_string \- return a string representation of the MI status.
.SH SYNOPSIS
.B "const char *" nvme_mi_status_to_string
.BI "(int status "  ");"
.SH ARGUMENTS
.IP "status" 12
MI response status
.SH "DESCRIPTION"
Gives a string description of \fIstatus\fP, as per section 4.1.2 of the NVMe-MI
spec. The status value should be of type NVME_STATUS_MI, and extracted
from the return value using \fBnvme_status_get_value\fP.

Returned string is const, and should not be \fBfree\fPed.
.SH "RETURN"
A string representing the status value