MprConfigTransportEnum 函式 (mprapi.h)

MprConfigTransportEnum 函式會列舉路由器上設定的傳輸。

語法

DWORD MprConfigTransportEnum(
  [in]                HANDLE  hMprConfig,
  [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] dwLevel

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

[in, out] lplpBuffer

在輸入上，非 NULL 指標。

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

[in] dwPrefMaxLen

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

[out] lpdwEntriesRead

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

[out] lpdwTotalEntries

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

[in, out, optional] lpdwResumeHandle

DWORD 變數的指標。

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

在輸出上，此變數包含用來繼續列舉的繼續句柄。 如果句柄為 NULL，則列舉已完成。

如果列舉中發生錯誤，這個句柄會無效。

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

傳回值

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

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

規格需求

另請參閱

FormatMessage

MprConfigBufferFree

MprConfigServerConnect

路由器設定函式

路由器管理參考