summaryrefslogtreecommitdiffstats
path: root/doc/man/nvmf_get_discovery_wargs.2
blob: 8a3e23291aa63415bc8b5fe965e84727133f232a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
.TH "nvmf_get_discovery_wargs" 9 "nvmf_get_discovery_wargs" "February 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_get_discovery_wargs \- Get the discovery log page with args
.SH SYNOPSIS
.B "struct nvmf_discovery_log *" nvmf_get_discovery_wargs
.BI "(struct nvme_get_discovery_args *args "  ");"
.SH ARGUMENTS
.IP "args" 12
Argument structure
.SH "DESCRIPTION"
This function is similar to \fBnvmf_get_discovery_log\fP, but
takes an extensible \fIargs\fP parameter. \fIargs\fP provides more
options than \fBnvmf_get_discovery_log\fP.

This function performs a get discovery log page (DLP) command
and returns the DLP. The memory allocated for the returned
DLP must be freed by the caller using \fBfree\fP.
.SH "RETURN"
Pointer to the discovery log page (to be freed). NULL
on failure and errno is set.