lib/libc/net/sctp_getaddrlen.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)send.2        8.2 (Berkeley) 2/21/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd December 15, 2006
  32 .Dt SCTP_GETADDRLEN 3
  33 .Os
  34 .Sh NAME
  35 .Nm sctp_getaddrlen
  36 .Nd return the address length of an address family
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/socket.h
  42 .In netinet/sctp.h
  43 .Ft int
  44 .Fn sctp_getaddrlen "sa_family_t family"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn sctp_getaddrlen
  48 function returns the size of a specific address family.
  49 This function
  50 is provided for application binary compatibility since it
  51 provides the application with the size the operating system
  52 thinks the specific address family is.
  53 Note that the function
  54 will actually create an SCTP socket and then gather the
  55 information via a
  56 .Fn getsockopt
  57 system calls.
  58 If for some reason a SCTP socket cannot
  59 be created or the
  60 .Fn getsockopt
  61 call fails, an error will be returned
  62 with
  63 .Va errno
  64 set as specified in the
  65 .Fn socket
  66 or
  67 .Fn getsockopt
  68 system call.
  69 .Sh RETURN VALUES
  70 The call returns the number of bytes that the operating
  71 system expects for the specific address family or -1.
  72 .Sh ERRORS
  73 The
  74 .Fn sctp_getaddrlen
  75 function can return the following errors:
  76 .Bl -tag -width Er
  77 .It Bq Er EINVAL
  78 The address family specified does NOT exist.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr getsockopt 2 ,
  82 .Xr socket 2 ,
  83 .Xr sctp 4