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

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_GET_CAS_NAMES 3  "May 21, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_get_cas_names \- get list of available InfiniBand device names
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_get_cas_names(char " "cas[][UMAD_CA_NAME_LEN]" ", int " "max" );
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B umad_get_cas_names()
  14 fills the
  15 .I cas
  16 array with up to
  17 .I max
  18 local IB devices (CAs) names.
  19 The argument
  20 .I cas
  21 is a character array with
  22 .I max
  23 entries, each with
  24 .B UMAD_CA_NAME_LEN
  25 characters.
  26 .SH "RETURN VALUE"
  27 .B umad_get_cas_names()
  28 returns a non-negative value equal to the number of entries filled,
  29 or \-1 on errors.
  30 .SH "SEE ALSO"
  31 .BR umad_get_ca_portguids (3),
  32 .BR umad_open_port (3)
  33 .SH "AUTHORS"
  34 .TP
  35 Hal Rosenstock <halr@voltaire.com>
  36 .TP
  37 Dotan Barak <dotanb@mellanox.co.il>