File: dmmp_path_array_get.3

package info (click to toggle)
multipath-tools 0.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,992 kB
  • sloc: ansic: 63,788; perl: 1,622; makefile: 729; sh: 647; pascal: 150
file content (25 lines) | stat: -rw-r--r-- 963 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
.TH "dmmp_path_array_get" 3 "dmmp_path_array_get" "August 2024" "Device Mapper Multipath API - libdmmp Manual" 
.SH NAME
dmmp_path_array_get \- Retrieve path pointer array.
.SH SYNOPSIS
.B "void" dmmp_path_array_get
.BI "(struct dmmp_path_group *" dmmp_pg ","
.BI "struct dmmp_path ***" dmmp_ps ","
.BI "uint32_t *" dmmp_p_count ");"
.SH ARGUMENTS
.IP "dmmp_pg" 12
Pointer of 'struct dmmp_path_group'.
If this pointer is NULL, your program will be terminated by assert.
.IP "dmmp_ps" 12
Output pointer of 'struct dmmp_path' pointer array.
If this pointer is NULL, your program will be terminated by assert.
.IP "dmmp_p_count" 12
Output pointer of uint32_t. Hold the size of 'dmmp_ps' pointer array.
If this pointer is NULL, your program will be terminated by assert.
.SH "DESCRIPTION"

The memory of output pointer array is hold by 'struct dmmp_mpath', no
need to free this memory, the resources will got freed when
\fBdmmp_mpath_array_free\fP.
.SH "RETURN"
void