PGET_INTERFACE_INFO回呼函式 (routprot.h)

GetInterfaceInfo 函式會取得特定介面的路由通訊協定所保留的組態資訊。

語法

PGET_INTERFACE_INFO PgetInterfaceInfo;

DWORD PgetInterfaceInfo(
  [in]      ULONG InterfaceIndex,
  [in]      PVOID InterfaceInfo,
  [in, out] PULONG BufferSize,
  [in]      PULONG StructureVersion,
  [in]      PULONG StructureSize,
  [in]      PULONG StructureCount
)
{...}

參數

[in] InterfaceIndex

指定路由器上所設定介面集合中的介面。

[in] InterfaceInfo

緩衝區的指標，這個緩衝區會接收與 介面相關聯的通訊協定定義組態資訊。 此資訊是路由通訊協定的私人資訊。

[in, out] BufferSize

DWORD 變數的指標。

輸入時：此變數會指定提供給接收組態資訊的緩衝區大小，以位元組為單位。

輸出時：此變數會接收緩衝區中放置之數據的大小，以位元組為單位。 如果初始大小不夠大，此變數會包含保存所有資料所需的大小。

[in] StructureVersion

指定 InterfaceInfo 參數所指向的信息結構版本。 在某些情況下，這等於路由通訊協定的版本。

[in] StructureSize

指定 InterfaceInfo 參數所指向之每個資訊結構的大小。 由於某些資訊結構包含可變長度成員，因此路由通訊協定不一定能夠判斷版本的資訊大小。

[in] StructureCount

指定 InterfaceInfo 參數所指向的信息結構數目計數。 此參數一律為一個。

傳回值

如果函式成功，傳回值會NO_ERROR。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

值	Description
ERROR_CAN_NOT_COMPLETE	嘗試擷取信息失敗。
ERROR_INVALID_PARAMETER	InterfaceIndex 參數無效 (例如，該索引) 沒有任何介面存在，或 InterfaceInfoSize 參數為 NULL。
ERROR_INSUFFICIENT_BUFFER	提供的輸出緩衝區大小不夠大，無法保存要求的資訊。 介面InfoSize 所指向的 DWORD 變數中會傳回必要的大小。

 

 

規格需求

需求	值
最低支援的用戶端	都不支援
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	routprot.h

另請參閱

路由通訊協定介面函式

路由通訊協定介面參考

SetInterfaceInfo