summaryrefslogtreecommitdiffstats
path: root/doc/man/nvmf_get_discovery_log.2
blob: 320cc612d20e2ced30f28b29f0633c4721fc7adb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "August 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_get_discovery_log \- Return the discovery log page
.SH SYNOPSIS
.B "int" nvmf_get_discovery_log
.BI "(nvme_ctrl_t c "  ","
.BI "struct nvmf_discovery_log **logp "  ","
.BI "int max_retries "  ");"
.SH ARGUMENTS
.IP "c" 12
Discovery controller to use
.IP "logp" 12
Pointer to the log page to be returned
.IP "max_retries" 12
Number of retries in case of failure
.SH "DESCRIPTION"
The memory allocated for the log page and returned in \fIlogp\fP
must be freed by the caller using \fBfree\fP.
.SH "NOTE"
Consider using \fBnvmf_get_discovery_wargs\fP instead.
.SH "RETURN"
0 on success; on failure -1 is returned and errno is set