MprConfigInterfaceTransportEnum 函式 (mprapi.h)

發行項
08/24/2023

MprConfigInterfaceTransportEnum函式會列舉指定介面上設定的傳輸。

語法

DWORD MprConfigInterfaceTransportEnum(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                DWORD   dwLevel,
  [in, out]           LPBYTE  *lplpBuffer,
  [in]                DWORD   dwPrefMaxLen,
  [out]               LPDWORD lpdwEntriesRead,
  [out]               LPDWORD lpdwTotalEntries,
  [in, out, optional] LPDWORD lpdwResumeHandle
);

參數

[in] hMprConfig

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

[in] hRouterInterface

要從中列舉傳輸的介面組態控制碼。呼叫 MprConfigInterfaceCreate或 MprConfigInterfaceEnum來取得此控制碼。

[in] dwLevel

DWORD值，描述lplpBuffer參數中傳回信息的格式。必須為零。

[in, out] lplpBuffer

在輸入上，非Null 指標。

成功完成時，指向MPR_IFTRANSPORT_0 結構的陣列指標。呼叫 MprConfigBufferFree以釋放此記憶體緩衝區。

[in] dwPrefMaxLen

以 8 位位元組 () 指定所傳回資料的慣用最大長度) 。如果此參數為 -1，傳回的緩衝區就足以保存所有可用的資訊。

[out] lpdwEntriesRead

DWORD變數的指標。此變數會接收從目前繼續位置列舉的專案總數。

[out] lpdwTotalEntries

DWORD變數的指標。此變數會接收可能已從目前繼續位置列舉的專案總數。

[in, out, optional] lpdwResumeHandle

DWORD變數的指標。

在輸入時，控制碼應該在第一次呼叫時為零，並在後續呼叫時保持不變。

在輸出上，此變數包含用來繼續列舉的繼續控制碼。如果控制碼為 Null，則列舉已完成。

如果列舉中發生錯誤，這個控制碼會無效。

這是選擇性參數。如果呼叫應用程式指定此參數的 Null ，函式不會傳回繼續控制碼。

傳回值

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

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

值	意義
ERROR_INVALID_PARAMETER	以下其中一項為正確： hMprConfig 為 Null。 HRouterInterface 為 Null。 dwLevel 不是零。 lplpBuffer 為 Null。 dwPrefMaxLen 小於單一 MPR_IFTRANSPORT_0 結構的大小。 lpdwEntriesRead 為 Null。 lpdwTotalEntries 為 Null。
ERROR_NOT_ENOUGH_MEMORY	資源不足，無法完成作業。
ERROR_NO_MORE_ITEMS	目前繼續位置不再提供任何專案。
其他	使用 FormatMessage 擷取對應至傳回之錯誤碼的系統錯誤訊息。

需求


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