GetIpPathTable 函式
GetIpPathEntry函式會擷取本機電腦上的 IP 路徑專案資訊。
語法
NETIOAPI_API GetIpPathTable(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_IPPATH_TABLE *Table
);
參數
系列 [in]
要擷取的位址系列。位址系列的可能值列在 Winsock2.h 標頭檔中。 請注意，AF_位址系列和PF_通訊協定系列常數的值 (相同，例如AF_INET和PF_INET) ，因此您可以使用任一常數。
在 Windows Vista 和更新版本的 Windows 作業系統上， Family 參數的可能值定義在 Ws2def.h 標頭檔中。 請注意，Ws2def.h 標頭檔會自動包含在 Netioapi.h 中，您不應該直接使用 Ws2def.h。
位址系列目前支援下列值：
AF_INET
IPv4 位址系列。 指定這個值時，此函式會傳回只包含 IPv4 專案的 IP 路徑資料表。AF_INET6
IPv6 位址系列。 指定這個值時，此函式會傳回只包含 IPv6 專案的 IP 路徑資料表。AF_UNSPEC
未指定位址系列。 指定此值時，此函式會傳回包含 IPv4 和 IPv6 專案的 IP 路徑資料表。
資料表 [out]
MIB_IPPATH_TABLE 結構的指標 ，其中包含本機電腦上的 IP 路徑專案資料表。
傳回值
如果函式成功，GetIpPathEntry會傳回STATUS_SUCCESS。
如果函式失敗， GetIpPathEntry 會傳回下列其中一個錯誤碼：
| 傳回碼 | 描述 |
|---|---|
| STATUS_INVALID_PARAMETER | 不正確參數已傳遞至 函式。 如果在Table參數中傳遞Null指標，或Family參數未指定為AF_INET、AF_INET6或AF_UNSPEC，就會傳回此錯誤。 |
| STATUS_NOT_ENOUGH_MEMORY | 記憶體資源不足，無法完成作業。 |
| STATUS_NOT_FOUND | 找不到 Family 參數中指定的 IP 路徑專案。 |
| STATUS_NOT_SUPPORTED | 不支援此要求。 如果本機電腦上沒有 IPv4 堆疊，而且在 Family 參數中指定了AF_INET，或者沒有 IPv6 堆疊位於本機電腦上，而且已在 Family 參數中指定AF_INET6，就會傳回此錯誤。 這個錯誤也會在不支援此函式的 Windows 版本上傳回。 |
| 其他 | 使用 FormatMessage 函式來取得傳回錯誤的訊息字串。 |
備註
GetIpPathTable函式會列舉本機電腦上的 IP 路徑專案，並在MIB_IPPATH_TABLE結構中傳回這項資訊。
GetIpPathTable 會傳回 Table 參數指向之緩衝區中MIB_IPPATH_TABLE結構中的 IP 路徑專案。 MIB_IPPATH_TABLE 結構包含 IP 路徑專案計數，以及每個 IP 路徑專案 之MIB_IPPATH_ROW 結構的陣列。 不再需要這些傳回的結構時，您的驅動程式應該呼叫 FreeMibTable來釋放記憶體。
您的驅動程式必須將 Family 參數初始化為 AF_INET、AF_INET6 或 AF_UNSPEC。
請注意，傳回的 MIB_IPPATH_TABLE 結構， Table 參數所指向的 結構可能包含 NumEntries 成員與 MIB_IPPATH_TABLE 結構之 Table 成員中第一個MIB_IPPATH_ROW陣列專案的填補。 對齊方式的填補也可能出現在MIB_IPPATH_ROW陣列專案之間。 任何對MIB_IPPATH_ROW陣列專案的存取都應該假設可能存在填補。
規格需求
目標平台 |
普遍 |
版本 |
可在 Windows Vista 和更新版本的 Windows 作業系統中使用。 |
標頭 |
Netioapi.h (包括 Netioapi.h) |
程式庫 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |