MprConfigInterfaceTransportGetInfo 函式 (mprapi.h)

發行項
08/24/2023

MprConfigInterfaceTransportGetInfo函式會擷取指定介面上指定用戶端的組態資訊。

語法

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

參數

[in] hMprConfig

路由器組態的控制碼。藉由呼叫 MprConfigServerConnect來取得此控制碼。

[in] hRouterInterface

處理要從中擷取指定用戶端資訊的介面組態。呼叫 MprConfigInterfaceCreate、 MprConfigInterfaceGetHandle或 MprConfigInterfaceEnum來取得此控制碼。

[in] hRouterIfTransport

處理要從中擷取指定用戶端資訊的傳輸組態。呼叫 MprConfigInterfaceTransportAdd、 MprConfigInterfaceTransportGetHandle或 MprConfigInterfaceTransportEnum來取得此控制碼。支援的傳輸通訊協定類型會列在傳輸識別碼上。

[in, out, optional] ppInterfaceInfo

在輸入上，指標變數的指標。

輸出時，此指標變數會指向包含用戶端組態資訊的資訊標頭。使用資訊標頭函式來管理資訊標頭。藉由呼叫 MprConfigBufferFree來釋放此記憶體。

這是選擇性參數。如果呼叫的應用程式指定此參數的 Null ，則函式不會傳回組態資訊。

[out, optional] lpdwInterfaceInfoSize

DWORD變數的指標。此變數會接收 ppInterfaceInfo所指向資料的大小，以位元組為單位。

此參數是選擇性的;呼叫的應用程式可以指定此參數的 Null 。不過，如果 ppInterfaceInfo 不是 Null，則此參數不能是 Null。如需詳細資訊，請參閱本主題稍後的＜備註＞一節。

傳回值

如果函式成功，傳回值會NO_ERROR。如需詳細資訊，請參閱本主題稍後的＜備註＞一節。

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

值	意義
ERROR_INVALID_PARAMETER	以下其中一項為正確： hMprConfig 為 Null。 hRouterInterface 為 Null。 hRouterIfTransport 為 Null。 ppInterfaceInfo 不是 Null，但 lpdwInterfaceInfoSize 是 Null。
ERROR_NO_SUCH_INTERFACE	在路由器組態中找不到 hRouterIfTransport 指定的介面，或未在指定的介面上啟用 hRouterIfTransport 指定的傳輸。
ERROR_NOT_ENOUGH_MEMORY	資源不足，無法完成作業。
其他	使用 FormatMessage 擷取對應至傳回之錯誤碼的系統錯誤訊息。

備註

如果 ppInterfaceInfo 參數為 Null， MprConfigInterfaceTransportGetInfo 不會執行任何動作，並以值NO_ERROR立即傳回。

需求


最低支援的用戶端	都不支援
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	mprapi.h
程式庫	Mprapi.lib
Dll	Mprapi.dll