.\" -*- nroff -*-
.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.\"
.TH UMAD_GET_CA_PORTGUIDS 3  "August 8, 2016" "OpenIB" "OpenIB Programmer\'s Manual"
.SH "NAME"
umad_get_ca_portguids \- get the InfiniBand device ports GUIDs
.SH "SYNOPSIS"
.nf
.B #include <infiniband/umad.h>
.sp
.BI "int umad_get_ca_portguids(char " "*ca_name" ", __be64 " "*portguids" ", int " "max" );
.fi
.SH "DESCRIPTION"
.B umad_get_ca_portguids()
fills the
.I portguids\fR
array with up to
.I max
port GUIDs belonging the specified IB device
.I ca_name
, or to the default IB device if
.I ca_name
is NULL.
The argument
.I portguids
is an array of
.I max
uint64_t entries.
.SH "RETURN VALUE"
On success,
.B umad_get_ca_portguids()
returns a non-negative value equal to the number of port GUIDs actually filled.
Not all filled entries may be valid. Invalid entries will be 0.
For example, on a CA node with only one port, this function returns a value of 2.
In this case, the value at index 0 will be invalid as it is reserved for switches.
On failure, a negative value is returned.
.SH "SEE ALSO"
.BR umad_get_cas_names (3)
.SH "AUTHORS"
.TP
Hal Rosenstock <halr@voltaire.com>
.TP
Dotan Barak <dotanb@mellanox.co.il>