MprConfigTransportGetInfo 函式 (mprapi.h)

發行項
03/15/2023

MprConfigTransportGetInfo函式會從路由器擷取指定傳輸通訊協定的組態。

語法

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

參數

[in] hMprConfig

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

[in] hRouterTransport

正在擷取之傳輸通訊協定組態的控制碼。呼叫 MprConfigTransportCreate、 MprConfigTransportGetHandle或 MprConfigTransportEnum來取得此控制碼。支援的傳輸通訊協定類型列在傳輸識別碼上。

[in, out, optional] ppGlobalInfo

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

在輸出時，這個指標變數會指向包含傳輸全域資訊的資訊標頭。使用資訊標頭函式來管理資訊標頭。呼叫 MprConfigBufferFree來釋放此緩衝區。

這是選擇性參數。如果呼叫應用程式指定此參數的 Null ，則函式不會擷取全域資訊。

[out, optional] lpdwGlobalInfoSize

DWORD變數的指標。此變數會接收透過 ppGlobalInfo 參數傳回之緩衝區的大小，以位元組為單位。

此參數是選擇性的;呼叫的應用程式可以指定這個參數的 Null 。不過，如果 ppGlobalInfo 不是 Null，則此參數不能是 Null。

[in, out, optional] ppClientInterfaceInfo

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

在輸出時，此指標會指向包含此傳輸之用戶端路由器預設介面資訊的資訊標頭。使用資訊標頭函式來管理資訊標頭。呼叫 MprConfigBufferFree來釋放緩衝區。

這是選擇性參數。如果呼叫應用程式指定此參數的 Null ，函式就不會擷取介面資訊。

[out, optional] lpdwClientInterfaceInfoSize

DWORD變數的指標。此變數會接收透過 ppClientInterfaceInfo 參數傳回之緩衝區的大小，以位元組為單位。

此參數是選擇性的;呼叫的應用程式可以指定這個參數的 Null 。不過，如果 ppClientInterfaceInfo 不是 Null，則此參數不能是 Null。

[in, out, optional] lplpwsDLLPath

在輸入時，指向 以 Null終止 Unicode 字串之指標的指標。

在輸出時，Unicode 字串會接收指定傳輸的路由器管理員 DLL 名稱。

這是選擇性參數。如果呼叫應用程式指定此參數的 Null ，此函式不會擷取路由器管理員 DLL 的名稱。

傳回值

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

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

值	意義
ERROR_INVALID_PARAMETER	至少符合下列其中一項條件： hMprConfig 為 Null hRouterTransport 為 Null ppGlobalInfo 不是 Null，但 lpdwGlobalInfoSize 為 Null。 ppClientInterfaceInfo 不是 Null，但 lpdwClientInterfaceInfo 是 Null。
ERROR_UNKNOWN_PROTOCOL_ID	路由器組態中找不到對應至 hRouterTransport 的傳輸通訊協定組態。
ERROR_NOT_ENOUGH_MEMORY	資源不足，無法完成作業。
其他	使用 FormatMessage 擷取對應至傳回之錯誤碼的系統錯誤訊息。

備註

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

需求


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