File: nvme_mi_status_to_string.2

package info (click to toggle)
libnvme 1.13-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 7,336 kB
  • sloc: ansic: 30,501; perl: 1,834; sh: 436; python: 190; cpp: 64; makefile: 54
file content (17 lines) | stat: -rw-r--r-- 653 bytes parent folder | download
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" "April 2025" "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