contrib/ofed/management/libibumad/man/umad_get_ca_portguids.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_GET_CA_PORTGUIDS 3  "May 11, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_get_ca_portguids \- get the InfiniBand device ports GUIDs
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_get_ca_portguids(char " "*ca_name" ", uint64_t " "*portguids" ", int " "max" );
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B umad_get_ca_portguids()
  14 fills the
  15 .I portguids\fR
  16 array with up to
  17 .I max
  18 port GUIDs belonging the specified IB device
  19 .I ca_name
  20 , or to the default IB device if
  21 .I ca_name
  22 is NULL.
  23 The argument
  24 .I portguids
  25 is an array of
  26 .I max
  27 uint64_t entries.
  28 .SH "RETURN VALUE"
  29 On success,
  30 .B umad_get_ca_portguids()
  31 returns a non-negative value equal to the number of port GUIDs actually filled.
  32 On failure, a negative value is returned.
  33 .SH "SEE ALSO"
  34 .BR umad_get_cas_names (3)
  35 .SH "AUTHORS"
  36 .TP
  37 Hal Rosenstock <halr@voltaire.com>
  38 .TP
  39 Dotan Barak <dotanb@mellanox.co.il>