GetIfTable 函式 (iphlpapi.h)
GetIfTable函式會擷取 MIB-II 介面資料表。
語法
IPHLPAPI_DLL_LINKAGE DWORD GetIfTable(
[out] PMIB_IFTABLE pIfTable,
[in, out] PULONG pdwSize,
[in] BOOL bOrder
);
參數
[out] pIfTable
接收介面資料表做為 MIB_IFTABLE 結構的緩衝區指標。
[in, out] pdwSize
在輸入時，指定 pIfTable 參數所指向之緩衝區的大小以位元組為單位。
在輸出中，如果緩衝區不夠大，無法保存傳回的介面資料表，函式會將此參數設定為等於所需的緩衝區大小以位元組為單位。
[in] bOrder
布林值，指定傳回的介面資料表是否應該依介面索引以遞增順序排序。 如果此參數為 TRUE，則會排序資料表。
傳回值
如果函式成功，傳回值會NO_ERROR。
如果函式失敗，傳回值就是下列其中一個錯誤碼。
| 傳回碼 | 描述 |
|---|---|
|
pIfTable參數所指向的緩衝區不夠大。 必要的大小會在pdwSize參數所指向的DWORD變數中傳回。 |
|
pdwSize參數為Null，或者GetIfTable無法寫入pdwSize參數所指向的記憶體。 |
|
本機系統上使用的作業系統不支援此函式。 |
|
使用 FormatMessage 函式來取得傳回錯誤的訊息字串。 |
備註
此
GetIfTable 函式會列舉本機系統上的實體介面，並在 MIB_IFTABLE 結構中傳回這項資訊。 實體介面包含軟體回送介面。
Windows Vista 和更新版本的GetIfTable2 和 GetIfTable2Ex函式是增強版的GetIfTable函式，可列舉本機系統上的實體和邏輯介面。 邏輯介面包含用於 L2TP、PPTP、PPOE 和其他通道封裝的各種 WAN Miniport 介面。
介面會在pIfTable參數所指向的緩衝區中MIB_IFTABLE結構中傳回。 MIB_IFTABLE結構包含介面計數和每個介面MIB_IFROW結構的陣列。
請注意，pIfTable參數所指向的傳回MIB_IFTABLE結構可能包含dwNumEntries成員與MIB_IFTABLE結構資料表成員中第一個MIB_IFROW陣列專案之間的對齊填補。 對齊方式的填補也可能存在於 MIB_IFROW 陣列專案之間。 任何對陣列專案 MIB_IFROW 的存取都應該假設可能存在填補。
範例
下列範例會擷取介面資料表，並列印資料表中的專案數目，以及每個專案上的一些資料。
#include <winsock2.h>
#include <ws2tcpip.h>
#pragma comment(lib, "IPHLPAPI.lib")
#include <iphlpapi.h>
#include <stdio.h>
#include <stdlib.h>
#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))
/* Note: could also use malloc() and free() */
int main()
{
// Declare and initialize variables.
DWORD dwSize = 0;
DWORD dwRetVal = 0;
unsigned int i, j;
/* variables used for GetIfTable and GetIfEntry */
MIB_IFTABLE *pIfTable;
MIB_IFROW *pIfRow;
// Allocate memory for our pointers.
pIfTable = (MIB_IFTABLE *) MALLOC(sizeof (MIB_IFTABLE));
if (pIfTable == NULL) {
printf("Error allocating memory needed to call GetIfTable\n");
return 1;
}
// Make an initial call to GetIfTable to get the
// necessary size into dwSize
dwSize = sizeof (MIB_IFTABLE);
if (GetIfTable(pIfTable, &dwSize, FALSE) == ERROR_INSUFFICIENT_BUFFER) {
FREE(pIfTable);
pIfTable = (MIB_IFTABLE *) MALLOC(dwSize);
if (pIfTable == NULL) {
printf("Error allocating memory needed to call GetIfTable\n");
return 1;
}
}
// Make a second call to GetIfTable to get the actual
// data we want.
if ((dwRetVal = GetIfTable(pIfTable, &dwSize, FALSE)) == NO_ERROR) {
printf("\tNum Entries: %ld\n\n", pIfTable->dwNumEntries);
for (i = 0; i < pIfTable->dwNumEntries; i++) {
pIfRow = (MIB_IFROW *) & pIfTable->table[i];
printf("\tIndex[%d]:\t %ld\n", i, pIfRow->dwIndex);
printf("\tInterfaceName[%d]:\t %ws", i, pIfRow->wszName);
printf("\n");
printf("\tDescription[%d]:\t ", i);
for (j = 0; j < pIfRow->dwDescrLen; j++)
printf("%c", pIfRow->bDescr[j]);
printf("\n");
printf("\tType[%d]:\t ", i);
switch (pIfRow->dwType) {
case IF_TYPE_OTHER:
printf("Other\n");
break;
case IF_TYPE_ETHERNET_CSMACD:
printf("Ethernet\n");
break;
case IF_TYPE_ISO88025_TOKENRING:
printf("Token Ring\n");
break;
case IF_TYPE_PPP:
printf("PPP\n");
break;
case IF_TYPE_SOFTWARE_LOOPBACK:
printf("Software Lookback\n");
break;
case IF_TYPE_ATM:
printf("ATM\n");
break;
case IF_TYPE_IEEE80211:
printf("IEEE 802.11 Wireless\n");
break;
case IF_TYPE_TUNNEL:
printf("Tunnel type encapsulation\n");
break;
case IF_TYPE_IEEE1394:
printf("IEEE 1394 Firewire\n");
break;
default:
printf("Unknown type %ld\n", pIfRow->dwType);
break;
}
printf("\tMtu[%d]:\t\t %ld\n", i, pIfRow->dwMtu);
printf("\tSpeed[%d]:\t %ld\n", i, pIfRow->dwSpeed);
printf("\tPhysical Addr:\t ");
if (pIfRow->dwPhysAddrLen == 0)
printf("\n");
for (j = 0; j < pIfRow->dwPhysAddrLen; j++) {
if (j == (pIfRow->dwPhysAddrLen - 1))
printf("%.2X\n", (int) pIfRow->bPhysAddr[j]);
else
printf("%.2X-", (int) pIfRow->bPhysAddr[j]);
}
printf("\tAdmin Status[%d]:\t %ld\n", i, pIfRow->dwAdminStatus);
printf("\tOper Status[%d]:\t ", i);
switch (pIfRow->dwOperStatus) {
case IF_OPER_STATUS_NON_OPERATIONAL:
printf("Non Operational\n");
break;
case IF_OPER_STATUS_UNREACHABLE:
printf("Unreachable\n");
break;
case IF_OPER_STATUS_DISCONNECTED:
printf("Disconnected\n");
break;
case IF_OPER_STATUS_CONNECTING:
printf("Connecting\n");
break;
case IF_OPER_STATUS_CONNECTED:
printf("Connected\n");
break;
case IF_OPER_STATUS_OPERATIONAL:
printf("Operational\n");
break;
default:
printf("Unknown status %ld\n", pIfRow->dwAdminStatus);
break;
}
printf("\n");
}
} else {
printf("GetIfTable failed with error: \n", dwRetVal);
if (pIfTable != NULL) {
FREE(pIfTable);
pIfTable = NULL;
}
return 1;
// Here you can use FormatMessage to find out why
// it failed.
}
if (pIfTable != NULL) {
FREE(pIfTable);
pIfTable = NULL;
}
return 0;
}
需求
| 最低支援的用戶端 | Windows 2000 專業版 [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
| 目標平台 | Windows |
| 標頭 | iphlpapi.h |
| 程式庫 | Iphlpapi.lib |
| Dll | Iphlpapi.dll |