summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_ctrl_get_src_addr.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_ctrl_get_src_addr.2')
-rw-r--r--doc/man/nvme_ctrl_get_src_addr.217
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man/nvme_ctrl_get_src_addr.2 b/doc/man/nvme_ctrl_get_src_addr.2
new file mode 100644
index 0000000..effafa4
--- /dev/null
+++ b/doc/man/nvme_ctrl_get_src_addr.2
@@ -0,0 +1,17 @@
+.TH "nvme_ctrl_get_src_addr" 9 "nvme_ctrl_get_src_addr" "February 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_ctrl_get_src_addr \- Extract src_addr from the c->address string
+.SH SYNOPSIS
+.B "char *" nvme_ctrl_get_src_addr
+.BI "(nvme_ctrl_t c " ","
+.BI "char *src_addr " ","
+.BI "size_t src_addr_len " ");"
+.SH ARGUMENTS
+.IP "c" 12
+Controller instance
+.IP "src_addr" 12
+Where to copy the src_addr. Size must be at least INET6_ADDRSTRLEN.
+.IP "src_addr_len" 12
+Length of the buffer \fIsrc_addr\fP.
+.SH "RETURN"
+Pointer to \fIsrc_addr\fP on success. NULL on failure to extract the src_addr.