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