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.\" 30.Dd December 15, 2006 31.Dt SCTP_GETADDRLEN 3 32.Os 33.Sh NAME 34.Nm sctp_getaddrlen 35.Nd return the address length of an address family 36.Sh LIBRARY 37.Lb libc 38.Sh SYNOPSIS 39.In sys/types.h 40.In sys/socket.h 41.In netinet/sctp.h 42.Ft int 43.Fn sctp_getaddrlen "sa_family_t family" 44.Sh DESCRIPTION 45The 46.Fn sctp_getaddrlen 47function returns the size of a specific address family. 48This function 49is provided for application binary compatibility since it 50provides the application with the size the operating system 51thinks the specific address family is. 52Note that the function 53will actually create an SCTP socket and then gather the 54information via a 55.Fn getsockopt 56system calls. 57If for some reason a SCTP socket cannot 58be created or the 59.Fn getsockopt 60call fails, an error will be returned 61with 62.Va errno 63set as specified in the 64.Fn socket 65or 66.Fn getsockopt 67system call. 68.Sh RETURN VALUES 69The call returns the number of bytes that the operating 70system expects for the specific address family or -1. 71.Sh ERRORS 72The 73.Fn sctp_getaddrlen 74function can return the following errors: 75.Bl -tag -width Er 76.It Bq Er EINVAL 77The address family specified does NOT exist. 78.El 79.Sh SEE ALSO 80.Xr getsockopt 2 , 81.Xr socket 2 , 82.Xr sctp 4 83