MprAdminConnectionEnum 函式 (mprapi.h)

發行項
03/05/2024

MprAdminConnectionEnum 函式會列舉所有作用中的連線。

語法

DWORD MprAdminConnectionEnum(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

參數

[in] hRasServer

處理列舉連接所在的 RAS 伺服器。藉由呼叫 MprAdminServerConnect 來取得此句柄。

[in] dwLevel

DWORD 值，描述 lplpbBuffer 參數中傳回資訊的格式。 dwLevel 可接受的值包括 0、1、2 和 3，如下表所列。

Windows NT 4.0：此參數必須是零。

值	結構格式
0	RAS_CONNECTION_0
1	Windows 2000 或更新版本： RAS_CONNECTION_1
2	Windows 2000 或更新版本： RAS_CONNECTION_2
3	Windows Server 2008 或更新版本： RAS_CONNECTION_3

[out] lplpbBuffer

成功完成時，描述連接之結構的陣列指標。根據 dwLevel 參數的值，這些結構的類型為RAS_CONNECTION_0、RAS_CONNECTION_1、RAS_CONNECTION_2或RAS_CONNECTION_3。

若要釋放此記憶體，請呼叫 MprAdminBufferFree。

[in] dwPrefMaxLen

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

[out] lpdwEntriesRead

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

[out] lpdwTotalEntries

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

[in] lpdwResumeHandle

DWORD 變數的指標。此變數會指定用來繼續列舉的繼續句柄。第一次呼叫時 ，lpdwResumeHandle 參數為零，後續呼叫時保持不變。如果傳回碼ERROR_MORE_DATA，可能會使用此句柄來擷取更多數據。如果句柄在傳回時為 NULL ，列舉就會完成。這個句柄對其他類型的錯誤傳回無效。

傳回值

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

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

值	意義
ERROR_DDM_NOT_RUNNING	需求撥號管理員 (DDM) 未執行，可能是因為動態介面管理員 (DIM) 設定為只在 LAN 上執行。
ERROR_INVALID_LEVEL	針對 dwLevel 傳遞的值不是零、一、二或三。只有 Windows 2000 或更新版本才支援層級 1 和 2。只有 Windows Server 2008 或更新版本才支援層級三。
ERROR_INVALID_PARAMETER	下列至少一個參數是 NULL ，或未指向有效的記憶體： lplpBuffer、 lpdwEntriesRead 或 lpdwTotalEntries。
ERROR_MORE_DATA	並非所有的數據都以這個呼叫傳回。若要取得其他數據，請使用繼續句柄再次呼叫函式。
RPC_S_INVALID_BINDING	傳入 hRasServer 參數的句柄為 NULL 或無效。
其他	來自 MprError.h、RasError.h 或 WinError.h 的錯誤。

備註

如果已安裝 RRAS 可轉散發套件，此函式可在 Windows NT 4.0 上使用。不過，隨附於 RRAS 可轉散發套件的 Mprapi.dll 版本會將函式導出為 RasAdminConnectionEnum ，而不是 MprAdminConnectionEnum。因此，使用 RRAS 可轉散發套件時，請使用 LoadLibrary 和 GetProcAddress 來存取此函式。

規格需求

需求	值
最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	mprapi.h
程式庫	Mprapi.lib
Dll	Mprapi.dll