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