diff options
Diffstat (limited to 'doc/man/nvme_ctrl_get_fd.2')
| -rw-r--r-- | doc/man/nvme_ctrl_get_fd.2 | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/man/nvme_ctrl_get_fd.2 b/doc/man/nvme_ctrl_get_fd.2 new file mode 100644 index 0000000..e8da7f4 --- /dev/null +++ b/doc/man/nvme_ctrl_get_fd.2 @@ -0,0 +1,18 @@ +.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "February 2024" "libnvme API manual" LINUX +.SH NAME +nvme_ctrl_get_fd \- Get associated file descriptor +.SH SYNOPSIS +.B "int" nvme_ctrl_get_fd +.BI "(nvme_ctrl_t c " ");" +.SH ARGUMENTS +.IP "c" 12 +Controller instance +.SH "DESCRIPTION" +libnvme will \fBopen\fP the file (if not already opened) and keep +an internal copy of the file descriptor. Following calls to +this API retrieve the internal cached copy of the file +descriptor. The file will remain opened and the fd will +remain cached until the controller object is deleted or +\fBnvme_ctrl_release_fd\fP is called. +.SH "RETURN" +File descriptor associated with \fIc\fP or -1 |