Fixed header dependencies to be fully compatible with the Windows
[wine/multimedia.git] / dlls / iphlpapi / ifenum.h
blob14fd659d506eba2b8335728eae332a8847ed02db
1 /* ifenum.h
2 * Copyright (C) 2003 Juan Lang
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 * This module implements functions shared by DLLs that need to enumerate
19 * network interfaces and addresses. It's meant to hide some problematic
20 * defines like socket(), as well as provide only one file
21 * that needs to be ported to implement these functions on different platforms,
22 * since the Windows API provides multiple ways to get at this info.
24 * Like Windows, it uses a numeric index to identify an interface uniquely.
25 * As implemented, an interface represents a UNIX network interface, virtual
26 * or real, and thus can have 0 or 1 IP addresses associated with it. (This
27 * only supports IPv4.)
28 * The indexes returned are not guaranteed to be contiguous, so don't call
29 * getNumInterfaces() and assume the values [0,getNumInterfaces() - 1] will be
30 * valid indexes; use getInterfaceIndexTable() instead. Non-loopback
31 * interfaces have lower index values than loopback interfaces, in order to
32 * make the indexes somewhat reusable as Netbios LANA numbers. See ifenum.c
33 * for more detail on this.
35 * See also the companion file, ipstats.h, for functions related to getting
36 * statistics.
38 #ifndef WINE_IFENUM_H_
39 #define WINE_IFENUM_H_
41 #include <stdarg.h>
43 #include "windef.h"
44 #include "winbase.h"
45 #include "iprtrmib.h"
47 #define MAX_INTERFACE_PHYSADDR 8
48 #define MAX_INTERFACE_DESCRIPTION 256
50 DWORD getNumInterfaces(void);
51 DWORD getNumNonLoopbackInterfaces(void);
53 /* A table of interface indexes, see get*InterfaceTable(). Ignore numAllocated,
54 * it's used during the creation of the table.
56 typedef struct _InterfaceIndexTable {
57 DWORD numIndexes;
58 DWORD numAllocated;
59 DWORD indexes[1];
60 } InterfaceIndexTable;
62 /* Returns a table with all known interface indexes, or NULL if one could not
63 * be allocated. free() the returned table.
65 InterfaceIndexTable *getInterfaceIndexTable(void);
67 /* Like getInterfaceIndexTable, but filters out loopback interfaces. */
68 InterfaceIndexTable *getNonLoopbackInterfaceIndexTable(void);
70 /* ByName/ByIndex versions of various getter functions. */
72 /* can be used as quick check to see if you've got a valid index, returns NULL
73 * if not. The buffer's only valid till the next call, so copy it right away
74 * if you care.
76 const char *getInterfaceNameByIndex(DWORD index);
78 /* Fills index with the index of name, if found. Returns
79 * ERROR_INVALID_PARAMETER if name or index is NULL, ERROR_INVALID_DATA if name
80 * is not found, and NO_ERROR on success.
82 DWORD getInterfaceIndexByName(const char *name, PDWORD index);
84 /* This bunch returns IP addresses, and INADDR_ANY or INADDR_NONE if not found,
85 * appropriately depending on the f/n.
87 DWORD getInterfaceIPAddrByName(const char *name);
88 DWORD getInterfaceIPAddrByIndex(DWORD index);
89 DWORD getInterfaceMaskByName(const char *name);
90 DWORD getInterfaceMaskByIndex(DWORD index);
91 DWORD getInterfaceBCastAddrByName(const char *name);
92 DWORD getInterfaceBCastAddrByIndex(DWORD index);
94 /* Gets a few physical charactersistics of a device: MAC addr len, MAC addr,
95 * and type as one of the MIB_IF_TYPEs.
96 * len's in-out: on in, needs to say how many bytes are available in addr,
97 * which to be safe should be MAX_INTERFACE_PHYSADDR. On out, it's how many
98 * bytes were set, or how many were required if addr isn't big enough.
99 * Returns ERROR_INVALID_PARAMETER if name, len, addr, or type is NULL.
100 * Returns ERROR_INVALID_DATA if name/index isn't valid.
101 * Returns ERROR_INSUFFICIENT_BUFFER if addr isn't large enough for the
102 * physical address; *len will contain the required size.
103 * May return other errors, e.g. ERROR_OUTOFMEMORY or ERROR_NO_MORE_FILES,
104 * if internal errors occur.
105 * Returns NO_ERROR on success.
107 DWORD getInterfacePhysicalByName(const char *name, PDWORD len, PBYTE addr,
108 PDWORD type);
109 DWORD getInterfacePhysicalByIndex(DWORD index, PDWORD len, PBYTE addr,
110 PDWORD type);
112 /* Get the operational status as a (MIB_)IF_OPER_STATUS type.
114 DWORD getInterfaceStatusByName(const char *name, PDWORD status);
115 DWORD getInterfaceStatusByIndex(DWORD index, PDWORD status);
117 DWORD getInterfaceMtuByName(const char *name, PDWORD mtu);
118 DWORD getInterfaceMtuByIndex(DWORD index, PDWORD mtu);
120 /* Fills in the MIB_IFROW by name/index. Doesn't fill in interface statistics,
121 * see ipstats.h for that.
122 * Returns ERROR_INVALID_PARAMETER if name or entry is NULL, ERROR_INVALID_DATA
123 * if name/index isn't valid, and NO_ERROR otherwise.
125 DWORD getInterfaceEntryByName(const char *name, PMIB_IFROW entry);
126 DWORD getInterfaceEntryByIndex(DWORD index, PMIB_IFROW entry);
128 /* Converts the network-order bytes in addr to a printable string. Returns
129 * string.
131 char *toIPAddressString(unsigned int addr, char string[16]);
133 #endif /* ndef WINE_IFENUM_H_ */