sctp_getaddrlen.3 (7c3768006d0adbe052143f13f0d969f422c9fd3e) | sctp_getaddrlen.3 (16c90ceeb35fa6183bb1348c38c30d5f13a5be17) |
---|---|
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. --- 31 unchanged lines hidden (view full) --- 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 | 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. --- 31 unchanged lines hidden (view full) --- 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"" | 48.Fn sctp_getaddrlen "sa_family_t family" |
49.Sh DESCRIPTION 50The 51.Fn sctp_getaddrlen | 49.Sh DESCRIPTION 50The 51.Fn sctp_getaddrlen |
52returns the size of a specific address family. This function | 52function returns the size of a specific address family. 53This function |
53is provided for application binary compatability since it 54provides the application with the size the operating system | 54is provided for application binary compatability since it 55provides the application with the size the operating system |
55thinks the specific address family is. Note that the function | 56thinks the specific address family is. 57Note that the function |
56will actually create an SCTP socket and then gather the 57information via a 58.Fn getsockopt | 58will actually create an SCTP socket and then gather the 59information via a 60.Fn getsockopt |
59system calls. If for some reason a SCTP socket cannot 60be created or the getsockopt fails, an error will be returned 61with errno set as specified in the | 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 |
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 | 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. |
|
72.Bl -tag -width Er 73.It Bq Er EINVAL 74The address family specified does NOT exist. 75.El 76.Sh SEE ALSO | 80.Bl -tag -width Er 81.It Bq Er EINVAL 82The address family specified does NOT exist. 83.El 84.Sh SEE ALSO |
77.Xr sctp 4 , 78.Xr socket 2 , | |
79.Xr getsockopt 2 , | 85.Xr getsockopt 2 , |
80 | 86.Xr socket 2 , 87.Xr sctp 4 |