<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
<!-- This material may be distributed only subject to the terms -->
|
<!-- This material may be distributed only subject to the terms -->
|
<!-- and conditions set forth in the Open Publication License, v1.0 -->
|
<!-- and conditions set forth in the Open Publication License, v1.0 -->
|
<!-- or later (the latest version is presently available at -->
|
<!-- or later (the latest version is presently available at -->
|
<!-- http://www.opencontent.org/openpub/). -->
|
<!-- http://www.opencontent.org/openpub/). -->
|
<!-- Distribution of the work or derivative of the work in any -->
|
<!-- Distribution of the work or derivative of the work in any -->
|
<!-- standard (paper) book form is prohibited unless prior -->
|
<!-- standard (paper) book form is prohibited unless prior -->
|
<!-- permission is obtained from the copyright holder. -->
|
<!-- permission is obtained from the copyright holder. -->
|
<HTML
|
<HTML
|
><HEAD
|
><HEAD
|
><TITLE
|
><TITLE
|
>getifaddrs</TITLE
|
>getifaddrs</TITLE
|
><meta name="MSSmartTagsPreventParsing" content="TRUE">
|
><meta name="MSSmartTagsPreventParsing" content="TRUE">
|
<META
|
<META
|
NAME="GENERATOR"
|
NAME="GENERATOR"
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
"><LINK
|
"><LINK
|
REL="HOME"
|
REL="HOME"
|
TITLE="eCos Reference Manual"
|
TITLE="eCos Reference Manual"
|
HREF="ecos-ref.html"><LINK
|
HREF="ecos-ref.html"><LINK
|
REL="UP"
|
REL="UP"
|
TITLE="TCP/IP Library Reference"
|
TITLE="TCP/IP Library Reference"
|
HREF="tcpip-library-reference.html"><LINK
|
HREF="tcpip-library-reference.html"><LINK
|
REL="PREVIOUS"
|
REL="PREVIOUS"
|
TITLE="gethostbyname"
|
TITLE="gethostbyname"
|
HREF="net-common-tcpip-manpages-gethostbyname.html"><LINK
|
HREF="net-common-tcpip-manpages-gethostbyname.html"><LINK
|
REL="NEXT"
|
REL="NEXT"
|
TITLE="getnameinfo"
|
TITLE="getnameinfo"
|
HREF="net-common-tcpip-manpages-getnameinfo.html"></HEAD
|
HREF="net-common-tcpip-manpages-getnameinfo.html"></HEAD
|
><BODY
|
><BODY
|
CLASS="SECT1"
|
CLASS="SECT1"
|
BGCOLOR="#FFFFFF"
|
BGCOLOR="#FFFFFF"
|
TEXT="#000000"
|
TEXT="#000000"
|
LINK="#0000FF"
|
LINK="#0000FF"
|
VLINK="#840084"
|
VLINK="#840084"
|
ALINK="#0000FF"
|
ALINK="#0000FF"
|
><DIV
|
><DIV
|
CLASS="NAVHEADER"
|
CLASS="NAVHEADER"
|
><TABLE
|
><TABLE
|
SUMMARY="Header navigation table"
|
SUMMARY="Header navigation table"
|
WIDTH="100%"
|
WIDTH="100%"
|
BORDER="0"
|
BORDER="0"
|
CELLPADDING="0"
|
CELLPADDING="0"
|
CELLSPACING="0"
|
CELLSPACING="0"
|
><TR
|
><TR
|
><TH
|
><TH
|
COLSPAN="3"
|
COLSPAN="3"
|
ALIGN="center"
|
ALIGN="center"
|
>eCos Reference Manual</TH
|
>eCos Reference Manual</TH
|
></TR
|
></TR
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="10%"
|
WIDTH="10%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
><A
|
><A
|
HREF="net-common-tcpip-manpages-gethostbyname.html"
|
HREF="net-common-tcpip-manpages-gethostbyname.html"
|
ACCESSKEY="P"
|
ACCESSKEY="P"
|
>Prev</A
|
>Prev</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="80%"
|
WIDTH="80%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
>Chapter 38. TCP/IP Library Reference</TD
|
>Chapter 38. TCP/IP Library Reference</TD
|
><TD
|
><TD
|
WIDTH="10%"
|
WIDTH="10%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
><A
|
><A
|
HREF="net-common-tcpip-manpages-getnameinfo.html"
|
HREF="net-common-tcpip-manpages-getnameinfo.html"
|
ACCESSKEY="N"
|
ACCESSKEY="N"
|
>Next</A
|
>Next</A
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><HR
|
><HR
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
WIDTH="100%"></DIV
|
WIDTH="100%"></DIV
|
><DIV
|
><DIV
|
CLASS="SECT1"
|
CLASS="SECT1"
|
><H1
|
><H1
|
CLASS="SECT1"
|
CLASS="SECT1"
|
><A
|
><A
|
NAME="NET-COMMON-TCPIP-MANPAGES-GETIFADDRS">getifaddrs</H1
|
NAME="NET-COMMON-TCPIP-MANPAGES-GETIFADDRS">getifaddrs</H1
|
><TABLE
|
><TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="SCREEN"
|
CLASS="SCREEN"
|
>GETIFADDRS(3) System Library Functions Manual GETIFADDRS(3)
|
>GETIFADDRS(3) System Library Functions Manual GETIFADDRS(3)
|
|
|
NAME
|
NAME
|
getifaddrs - get interface addresses
|
getifaddrs - get interface addresses
|
|
|
SYNOPSIS
|
SYNOPSIS
|
#include <sys/types.h>
|
#include <sys/types.h>
|
#include <sys/socket.h>
|
#include <sys/socket.h>
|
#include <ifaddrs.h>
|
#include <ifaddrs.h>
|
|
|
int
|
int
|
getifaddrs(struct ifaddrs **ifap);
|
getifaddrs(struct ifaddrs **ifap);
|
|
|
void
|
void
|
freeifaddrs(struct ifaddrs *ifap);
|
freeifaddrs(struct ifaddrs *ifap);
|
|
|
DESCRIPTION
|
DESCRIPTION
|
The getifaddrs() function stores a reference to a linked list of the net-
|
The getifaddrs() function stores a reference to a linked list of the net-
|
work interfaces on the local machine in the memory referenced by ifap.
|
work interfaces on the local machine in the memory referenced by ifap.
|
The list consists of ifaddrs structures, as defined in the include file
|
The list consists of ifaddrs structures, as defined in the include file
|
<ifaddrs.h>. The ifaddrs structure contains at least the following
|
<ifaddrs.h>. The ifaddrs structure contains at least the following
|
entries:
|
entries:
|
|
|
struct ifaddrs *ifa_next; /* Pointer to next struct */
|
struct ifaddrs *ifa_next; /* Pointer to next struct */
|
char *ifa_name; /* Interface name */
|
char *ifa_name; /* Interface name */
|
u_int ifa_flags; /* Interface flags */
|
u_int ifa_flags; /* Interface flags */
|
struct sockaddr *ifa_addr; /* Interface address */
|
struct sockaddr *ifa_addr; /* Interface address */
|
struct sockaddr *ifa_netmask; /* Interface netmask */
|
struct sockaddr *ifa_netmask; /* Interface netmask */
|
struct sockaddr *ifa_broadaddr; /* Interface broadcast address */
|
struct sockaddr *ifa_broadaddr; /* Interface broadcast address */
|
struct sockaddr *ifa_dstaddr; /* P2P interface destination */
|
struct sockaddr *ifa_dstaddr; /* P2P interface destination */
|
void *ifa_data; /* Address specific data */
|
void *ifa_data; /* Address specific data */
|
|
|
ifa_next
|
ifa_next
|
Contains a pointer to the next structure on the list. This field
|
Contains a pointer to the next structure on the list. This field
|
is set to NULL in last structure on the list.
|
is set to NULL in last structure on the list.
|
|
|
ifa_name
|
ifa_name
|
Contains the interface name.
|
Contains the interface name.
|
|
|
ifa_flags
|
ifa_flags
|
Contains the interface flags, as set by ifconfig(8).
|
Contains the interface flags, as set by ifconfig(8).
|
|
|
ifa_addr
|
ifa_addr
|
References either the address of the interface or the link level
|
References either the address of the interface or the link level
|
address of the interface, if one exists, otherwise it is NULL.
|
address of the interface, if one exists, otherwise it is NULL.
|
(The sa_family field of the ifa_addr field should be consulted to
|
(The sa_family field of the ifa_addr field should be consulted to
|
determine the format of the ifa_addr address.)
|
determine the format of the ifa_addr address.)
|
|
|
ifa_netmask
|
ifa_netmask
|
References the netmask associated with ifa_addr, if one is set,
|
References the netmask associated with ifa_addr, if one is set,
|
otherwise it is NULL.
|
otherwise it is NULL.
|
|
|
ifa_broadaddr
|
ifa_broadaddr
|
This field, which should only be referenced for non-P2P inter-
|
This field, which should only be referenced for non-P2P inter-
|
faces, references the broadcast address associated with ifa_addr,
|
faces, references the broadcast address associated with ifa_addr,
|
if one exists, otherwise it is NULL.
|
if one exists, otherwise it is NULL.
|
|
|
ifa_dstaddr
|
ifa_dstaddr
|
References the destination address on a P2P interface, if one
|
References the destination address on a P2P interface, if one
|
exists, otherwise it is NULL.
|
exists, otherwise it is NULL.
|
|
|
ifa_data
|
ifa_data
|
References address family specific data. For AF_LINK addresses
|
References address family specific data. For AF_LINK addresses
|
it contains a pointer to the struct if_data (as defined in
|
it contains a pointer to the struct if_data (as defined in
|
include file <net/if.h>) which contains various interface
|
include file <net/if.h>) which contains various interface
|
attributes and statistics. For all other address families, it
|
attributes and statistics. For all other address families, it
|
contains a pointer to the struct ifa_data (as defined in include
|
contains a pointer to the struct ifa_data (as defined in include
|
file <net/if.h>) which contains per-address interface statistics.
|
file <net/if.h>) which contains per-address interface statistics.
|
|
|
The data returned by getifaddrs() is dynamically allocated and should be
|
The data returned by getifaddrs() is dynamically allocated and should be
|
freed using freeifaddrs() when no longer needed.
|
freed using freeifaddrs() when no longer needed.
|
|
|
RETURN VALUES
|
RETURN VALUES
|
Upon successful completion, a value of 0 is returned. Otherwise, a value
|
Upon successful completion, a value of 0 is returned. Otherwise, a value
|
of -1 is returned and errno is set to indicate the error.
|
of -1 is returned and errno is set to indicate the error.
|
|
|
ERRORS
|
ERRORS
|
The getifaddrs() may fail and set errno for any of the errors specified
|
The getifaddrs() may fail and set errno for any of the errors specified
|
for the library routines ioctl(2), socket(2), malloc(3), or sysctl(3).
|
for the library routines ioctl(2), socket(2), malloc(3), or sysctl(3).
|
|
|
BUGS
|
BUGS
|
If both <net/if.h> and <ifaddrs.h> are being included, <net/if.h> must be
|
If both <net/if.h> and <ifaddrs.h> are being included, <net/if.h> must be
|
included before <ifaddrs.h>.
|
included before <ifaddrs.h>.
|
|
|
SEE ALSO
|
SEE ALSO
|
ioctl(2), socket(2), sysctl(3), networking(4), ifconfig(8)
|
ioctl(2), socket(2), sysctl(3), networking(4), ifconfig(8)
|
|
|
HISTORY
|
HISTORY
|
The getifaddrs() function first appeared in BSDI BSD/OS. The function is
|
The getifaddrs() function first appeared in BSDI BSD/OS. The function is
|
supplied on OpenBSD since OpenBSD 2.7.
|
supplied on OpenBSD since OpenBSD 2.7.
|
|
|
BSD February 24, 2003 BSD
|
BSD February 24, 2003 BSD
|
</PRE
|
</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
></DIV
|
></DIV
|
><DIV
|
><DIV
|
CLASS="NAVFOOTER"
|
CLASS="NAVFOOTER"
|
><HR
|
><HR
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
WIDTH="100%"><TABLE
|
WIDTH="100%"><TABLE
|
SUMMARY="Footer navigation table"
|
SUMMARY="Footer navigation table"
|
WIDTH="100%"
|
WIDTH="100%"
|
BORDER="0"
|
BORDER="0"
|
CELLPADDING="0"
|
CELLPADDING="0"
|
CELLSPACING="0"
|
CELLSPACING="0"
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="net-common-tcpip-manpages-gethostbyname.html"
|
HREF="net-common-tcpip-manpages-gethostbyname.html"
|
ACCESSKEY="P"
|
ACCESSKEY="P"
|
>Prev</A
|
>Prev</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="34%"
|
WIDTH="34%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="ecos-ref.html"
|
HREF="ecos-ref.html"
|
ACCESSKEY="H"
|
ACCESSKEY="H"
|
>Home</A
|
>Home</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="net-common-tcpip-manpages-getnameinfo.html"
|
HREF="net-common-tcpip-manpages-getnameinfo.html"
|
ACCESSKEY="N"
|
ACCESSKEY="N"
|
>Next</A
|
>Next</A
|
></TD
|
></TD
|
></TR
|
></TR
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="top"
|
VALIGN="top"
|
>gethostbyname</TD
|
>gethostbyname</TD
|
><TD
|
><TD
|
WIDTH="34%"
|
WIDTH="34%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="tcpip-library-reference.html"
|
HREF="tcpip-library-reference.html"
|
ACCESSKEY="U"
|
ACCESSKEY="U"
|
>Up</A
|
>Up</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="top"
|
VALIGN="top"
|
>getnameinfo</TD
|
>getnameinfo</TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
></DIV
|
></DIV
|
></BODY
|
></BODY
|
></HTML
|
></HTML
|
|
|