getifmaddrs man page on FreeBSD

Man page or keyword search:  
man Server   9747 pages
apropos Keyword Search (all sections)
Output format
FreeBSD logo
[printable version]

GETIFMADDRS(3)		 BSD Library Functions Manual		GETIFMADDRS(3)

     getifmaddrs — get multicast group memberships

     #include <sys/types.h>
     #include <sys/socket.h>
     #include <ifaddrs.h>

     getifmaddrs(struct ifmaddrs **ifmap);

     freeifmaddrs(struct ifmaddrs *ifmp);

     The getifmaddrs() function stores a reference to a linked list of the
     multicast memberships on the local machine in the memory referenced by
     ifmap.  The list consists of ifmaddrs structures, as defined in the
     include file <ifaddrs.h>.	The ifmaddrs structure contains at least the
     following entries:

	 struct ifmaddrs   *ifma_next;	   /* Pointer to next struct */
	 struct sockaddr   *ifma_name;	   /* Interface name (AF_LINK) */
	 struct sockaddr   *ifma_addr;	   /* Multicast address */
	 struct sockaddr   *ifma_lladdr;   /* Link-layer translation, if any */

     The ifma_next field contains a pointer to the next structure on the list.
     This field is NULL in last structure on the list.

     The ifma_name field references an AF_LINK address structure, containing
     the name of the interface where the membership exists.

     The ifma_addr references the address that this membership is for.

     The ifma_lladdr field references a link-layer translation for the proto‐
     col-level address in ifma_addr, if one is set, otherwise it is NULL.

     The data returned by getifmaddrs() is dynamically allocated and should be
     freed using freeifmaddrs() when no longer needed.

     The getifmaddrs() function returns the value 0 if successful; otherwise
     the value -1 is returned and the global variable errno is set to indicate
     the error.

     The getifmaddrs() may fail and set errno for any of the errors specified
     for the library routines malloc(3) or sysctl(3).

     sysctl(3), networking(4), ifconfig(8)

     The getifmaddrs() function first appeared in FreeBSD 5.2.

     If both <net/if.h> and <ifaddrs.h> are being included, <net/if.h> must be
     included before <ifaddrs.h>.

BSD			       November 14, 2003			   BSD

List of man pages available for FreeBSD

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net