MprConfigTransportSetInfo 函式 (mprapi.h)

發行項
02/29/2024

MprConfigTransportSetInfo 函式會變更指定路由器組態中指定傳輸通訊協定的組態。

語法

DWORD MprConfigTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterTransport,
  [in, optional] LPBYTE pGlobalInfo,
  [in, optional] DWORD  dwGlobalInfoSize,
  [in, optional] LPBYTE pClientInterfaceInfo,
  [in, optional] DWORD  dwClientInterfaceInfoSize,
  [in, optional] LPWSTR lpwsDLLPath
);

參數

[in] hMprConfig

路由器組態的句柄。呼叫 MprConfigServerConnect 以取得此句柄。

[in] hRouterTransport

正在更新之傳輸通訊協議組態的句柄。呼叫 MprConfigTransportCreate、 MprConfigTransportGetHandle 或 MprConfigTransportEnum 來取得此句柄。支援的傳輸通訊協議類型列在傳輸標識碼上。

[in, optional] pGlobalInfo

指定傳輸通訊協定全域資訊之資訊標頭的指標。傳輸的路由器管理員會解譯這項資訊。使用資訊標頭函式來管理信息標頭。

此參數是選擇性的;呼叫的應用程式可以指定這個參數的 NULL 。

[in, optional] dwGlobalInfoSize

指定 pGlobalInfo 所指向之數據的大小，以位元組為單位。如果呼叫應用程式為 pGlobalInfo 指定 NULL，則呼叫應用程式應該為此參數指定零。

[in, optional] pClientInterfaceInfo

指定用戶端路由器預設介面資訊的信息標頭指標。此資訊可用來設定此傳輸之用戶端路由器的動態介面。使用資訊標頭函式來管理信息標頭。

此參數是選擇性的;呼叫的應用程式可以指定此參數的 NULL 。

[in, optional] dwClientInterfaceInfoSize

指定 pClientInterfaceInfo 所指向之數據的大小，以位元組為單位。如果呼叫應用程式為 pClientInterfaceInfo 指定 NULL，則呼叫應用程式應該為此參數指定零。

[in, optional] lpwsDLLPath

指定指定指定傳輸之路由器管理員 DLL 名稱之 Null 終止 Unicode 字串的指標。

此參數是選擇性的;呼叫的應用程式可以指定這個參數的 NULL 。

傳回值

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

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

值	意義
ERROR_INVALID_PARAMETER	hMprConfig 參數為 NULL、hRouterTransport 參數為 NULL，或兩者皆為 NULL。
ERROR_UNKNOWN_PROTOCOL_ID	路由器組態中找不到對應至 hRouterTransport 的傳輸通訊協議組態。
其他	使用 FormatMessage 擷取對應至傳回之錯誤碼的系統錯誤訊息。

備註

使用 MprConfigTransportSetInfo 來設定傳輸的全域資訊、預設介面資訊，或傳輸的路由器管理員 DLL 名稱。

MprConfigTransportSetInfo 會嘗試依照專案出現在參數列表中的順序來設定專案：

全域資訊。
用戶端路由器的預設介面資訊。
路由器管理員 DLL 名稱。

如果 MprConfigTransportSetInfo 無法設定任何一個專案，它會立即傳回，而不會嘗試設定其餘專案。

如果 pGlobalInfo、 pClientInterfaceInfo 和 lpwsDLLPath 參數都是 NULL，則函式不會執行任何動作，並傳回值 NO_ERROR。

規格需求

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