if_nameindex(3n) [hpux man page]

if_nameindex(3N)														  if_nameindex(3N)

NAME

       if_nameindex(), if_nametoindex(), if_indextoname(), if_freenameindex() - functions that map between an interface name and index value

SYNOPSIS

DESCRIPTION

       Interfaces  are	normally  known by names such as "lan0" and "vlan200."	The index is a unique positive integer value assigned to an inter-
       face. Index values start at 1, and 0 is not a valid index.

       This function maps an interface name into its corresponding
	      index.  If the specified interface name does not exist, the return value is set to 0 and is set to If there is a system  error,  the
	      return value is 0, and is set to the appropriate value.  For example, if the system is running out of memory, will be set to

       This function maps an interface index into its corresponding
	      name.   The  ifname  argument  must point to a buffer of at least bytes into which the interface name corresponding to the specified
	      index is returned.  This pointer is also the return value of the function.  is defined in and its value includes a terminating  null
	      byte  at	the end of the interface name.	If there is no interface corresponding to the specified index, NULL is returned and is set
	      to If there is a system error, the return value is 0, and is set to the appropriate value.

       This function returns all interface names and indexes as
	      an array of structures, one structure per interface.  The structure is defined in

	      struct if_nameindex {
		     unsigned int   if_index;  /* 1, 2, ... */
		     char	   *if_name;   /* null terminated name: "lan0" */
	      };

	      The end of the array of structures is indicated by a structure with an if_index of 0, and an if_name of NULL.  The function  returns
	      a NULL pointer upon an error, and would set to the appropriate value.

	      The  memory  used  for this array of structures along with the interface names pointed to by the if_name members is obtained dynami-
	      cally.  This memory is freed by the next function.

       This function frees the dynamic memory allocated by
	      The argument to this function must be a pointer that was returned by

CHANGE HISTORY

       The function prototypes and were defined in prior to HP-UX 11i v3.  They are now defined in

       Beginning with HP-UX 11i v3, these functions may pass on both IPv4 and IPv6 interfaces, and they no longer  reside  in  the  IPv6  library.
       They currently reside in the C library.	Therefore, applications using these functions no longer need to link with Applications using other
       IPv6 interfaces that reside in IPv6 library will need to continue to link with

AUTHOR

       and were developed by HP, IETF, and X/Open Company Limited.

ERRORS

       When or fails, the following error message is set in

       The specified interface or index does not exist.

SEE ALSO

       ndp(1M), inet6_opt_init(3N), inet6_rth_space(3N), ip6(7P), ndp(7P).

       RFC 3493 Basic Socket Interface Extensions for IPv6.

STANDARDS CONFORMANCE

																  if_nameindex(3N)

if_nametoindex(3XNET)				   X/Open Networking Services Library Functions 			     if_nametoindex(3XNET)

NAME

       if_nametoindex,	if_indextoname,  if_nameindex, if_freenameindex - functions to map Internet Protocol network interface names and interface
       indexes

SYNOPSIS

       cc [ flag... ] file... -lxnet [ library... ]
       #include <net/if.h>

       unsigned int if_nametoindex(const char *ifname);

       char *if_indextoname(unsigned int ifindex, char *ifname);

       struct if_nameindex *if_nameindex(void);

       void if_freenameindex(struct if_nameindex *ptr);

PARAMETERS

       These functions support the following parameters:

       ifname	       interface name

       ifindex	       interface index

       ptr	       pointer returned by if_nameindex()

DESCRIPTION

       This API defines two functions that map between an Internet Protocol network interface name and index, a third function	that  returns  all
       the interface names and indexes, and a fourth function to return the dynamic memory allocated by the previous function.

       Network	interfaces  are  normally  known by names such as eri0, sl1, ppp2, and the like.  The ifname argument must point to a buffer of at
       least IF_NAMESIZE bytes into which the interface name corresponding  to	the  specified	index  is  returned.  IF_NAMESIZE  is  defined	in
       <net/if.h> and its value includes a terminating null byte at the end of the interface name.

       if_nametoindex()

	   The	if_nametoindex() function returns the interface index corresponding to the interface name pointed to by the ifname pointer. If the
	   specified interface name does not exist, the return value is 0, and errno is set to ENXIO. If there was a system error, such as running
	   out of memory, the return value is 0 and errno is set to the proper value, for example, ENOMEM.

       if_indextoname()

	   The	if_indextoname()  function maps an interface index into its corresponding name. This pointer is also the return value of the func-
	   tion.  If there is no interface corresponding to the specified index, NULL is returned, and errno is set to ENXIO, if there was a  sys-
	   tem	error,	such  as  running  out	of  memory, if_indextoname() returns NULL and errno would be set to the proper value, for example,
	   ENOMEM.

       *if_nameindex()

	   The if_nameindex() function returns an array of if_nameindex structures, one structure per interface. The if_nameindex structure  holds
	   the information about a single interface and is defined when the <net/if.h> header is included:

	   struct if_nameindex {
	       unsigned int   if_index;  /* 1, 2, ... */
	       char	      *if_name;   /* null terminated name: "eri0", ... */
	   };

	   The	end  of  the  array of structures is indicated by a structure with an if_index of 0 and an if_name of NULL. The function returns a
	   null pointer upon an error and sets errno to the appropriate value. The memory used for this array of structures along with the  inter-
	   face names pointed to by the if_name members is obtained dynamically. This memory is freed by the if_freenameindex() function.

       if_freenameindex()

	   The	if_freenameindex() function frees the dynamic memory that was allocated by if_nameindex(). The argument to this function must be a
	   pointer that was returned by if_nameindex().

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWcsl (32-bit)		   |
       +-----------------------------+-----------------------------+
       |			     |SUNWcslx (64-bit) 	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       ifconfig(1M), if_nametoindex(3SOCKET), attributes(5), standards(5), if(7P)

SunOS 5.10							    14 Dec 2003 					     if_nametoindex(3XNET)