PGET_NEIGHBORS回呼函式 (routprot.h)
路由器管理員會呼叫 GetNeigbeers 函式,以取得透過指定介面連結之網路的仲裁器。
PGET_NEIGHBORS類型會定義這個回呼函式的指標。 GetNeigbeers 是應用程式定義函數名稱的佔位元。
語法
PGET_NEIGHBORS PgetNeighbors;
DWORD PgetNeighbors(
[in] DWORD InterfaceIndex,
[in] PDWORD NeighborList,
[in, out] PDWORD NeighborListSize,
[out] PBYTE InterfaceFlags
)
{...}
參數
[in] InterfaceIndex
指定路由通訊協議應該提供仲裁器之介面的索引。
[in] NeighborList
數位 DWORD 變數的指標。 路由通訊協議應該會填入此數位元位址。
如果本機計算機是透過指定介面連結之網路的仲裁器,路由通訊協定就不需要填入此變數。 相反地,路由通訊協議應該將 NeighborListSize 指向的值設定為零。 此外,路由通訊協議應該將 MRINFO_QUERIER_FLAG 新增至 InterfaceFlags 參數中傳回的旗標。
[in, out] NeighborListSize
在輸入上,指向 DWORD 變數的指標。
在輸出上,路由通訊協定會填入此變數的長度,以位元組為單位,以 在NeighborList 參數中傳回的位址。
[out] InterfaceFlags
接收下列一或多個旗標。 旗標描述本機電腦與透過指定介面連結之網路上其他計算機的關聯性。
MRINFO_TUNNEL_FLAG MRINFO_PIM_FLAG MRINFO_DOWN_FLAG MRINFO_DISABLED_FLAGMRINFO_QUERIER_FLAGMRINFO_LEAF_FLAG
傳回值
如果函式成功,傳回值 會NO_ERROR。
如果函式失敗,傳回值就是下列其中一個錯誤碼。
值 | Description |
---|---|
|
路由通訊協議無法完成要求。 |
|
NeighborList 所指向的緩衝區大小不足以保存位址。 所需的大小會在由 NeighborListSize 參數指向的 DWORD 變數中傳回。 |
|
例如,InterfaceIndex 參數無效 (,該索引) 沒有任何介面存在。 |
備註
只需要多播路由通訊協定才能實作此函式。 非多播路由通訊協議應該在 MPR_ROUTING_CHARACTERISTICS 中傳遞NULL 作為此函式的指標值
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 都不支援 |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | routprot.h |