MprAdminInterfaceEnum 函式 (mprapi.h)

MprAdminInterfaceEnum 函式會列舉指定伺服器上的所有介面。

語法

DWORD MprAdminInterfaceEnum(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

參數

[in] hMprServer

處理要在其中執行此呼叫的路由器。 呼叫 MprAdminServerConnect 以取得此句柄。

[in] dwLevel

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

[out] lplpbBuffer

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

[in] dwPrefMaxLen

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

[out] lpdwEntriesRead

DWORD 變數的指標。 此變數會接收從列舉中目前位置列舉的介面總數。

[out] lpdwTotalEntries

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

[in] lpdwResumeHandle

DWORD 變數的指標。 此變數會指定可用來繼續列舉的繼續句柄。 句柄應該在第一次呼叫時為零，並在後續呼叫時保持不變。 如果傳回碼ERROR_MORE_DATA則可以使用句柄重新發出呼叫，以擷取更多數據。 如果傳回時，句柄為 NULL，則無法繼續列舉。 對於其他類型的錯誤傳回，此句柄無效。

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

傳回值

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

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

規格需求

另請參閱

MPR_INTERFACE_0

MprAdminBufferFree

MprAdminServerConnect

路由器管理功能

路由器管理參考