MprAdminPortEnum 函式 (mprapi.h)
MprAdminPortEnum 函式會列舉特定連線中的所有作用中埠,或可供 RAS 使用或目前使用的所有埠。
語法
DWORD MprAdminPortEnum(
[in] RAS_SERVER_HANDLE hRasServer,
[in] DWORD dwLevel,
[in] HANDLE hRasConnection,
[out] LPBYTE *lplpbBuffer,
[in] DWORD dwPrefMaxLen,
[out] LPDWORD lpdwEntriesRead,
[out] LPDWORD lpdwTotalEntries,
[in] LPDWORD lpdwResumeHandle
);
參數
[in] hRasServer
要列舉其埠之 RAS 伺服器的句柄。 若要取得此句柄,請呼叫 MprAdminServerConnect。
[in] dwLevel
DWORD 值,描述 lplpbBuffer 參數中傳回資訊的格式。 必須為零。
[in] hRasConnection
列舉作用中埠之連接的句柄。 如果此參數 INVALID_HANDLE_VALUE,則會列舉 RRAS 使用或可供使用的所有埠。 若要取得此句柄,請呼叫 MprAdminConnectionEnum。
[out] lplpbBuffer
成功完成時,指向描述埠 之RAS_PORT_0 結構的陣列指標。 呼叫 MprAdminBufferFree 來釋放此記憶體。
[in] dwPrefMaxLen
值,指定所傳回數據的慣用最大長度,以8位位元組為單位。 如果此參數為 -1,傳回的緩衝區就足以保存所有可用的數據。
[out] lpdwEntriesRead
DWORD 變數的指標。 此變數會接收從目前繼續位置列舉的埠總數。
[out] lpdwTotalEntries
DWORD 變數的指標。 此變數會接收可能已從目前繼續位置列舉的埠總數。
[in] lpdwResumeHandle
DWORD 變數的指標。 成功執行時,此參數會指定可用來繼續列舉的句柄。 第一次呼叫時,此參數應該是零,後續呼叫時保持不變。 如果傳回碼 ERROR_MORE_DATA,可以使用句柄重新發出呼叫,以擷取更多數據。 如果傳回時句柄為 NULL ,則無法繼續列舉。 這個句柄對其他類型的錯誤傳回無效。
傳回值
如果函式成功,傳回值會 NO_ERROR。
如果函式失敗,傳回值就是下表所列的其中一個錯誤碼。
值 | 意義 |
---|---|
|
呼叫的應用程式沒有足夠的許可權。 |
|
要求撥號管理員 (DDM) 未執行,可能是因為動態介面管理員 (DIM) 設定為只在 LAN 上執行。 |
|
至少下列其中一個參數是 NULL ,或未指向有效的記憶體: lplpBuffer、 lpdwEntriesRead 或 lpdwTotalEntries。 |
|
並非所有的數據都是透過這個呼叫傳回。 若要取得其他數據,請使用 IpdwResumeHandle 參數中傳回的句柄再次呼叫函式。 |
|
dwLevel 參數不是零。 |
|
hConnection 參數為 NULL。 |
|
MprError.h、RasError.h 或 WinError.h 的錯誤。 |
備註
如果已安裝 RRAS 可轉散發套件,則此函式可在 Windows NT 4.0 上使用。 不過,RRAS 可轉散發套件所提供的 Mprapi.dll 版本會將函式導出為 RasAdminPortEnum ,而不是 MprAdminPortEnum。 因此,使用 RRAS 可轉散發套件時,請使用 LoadLibrary 和 GetProcAddress 來存取此函式。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | mprapi.h |
程式庫 | Mprapi.lib |
Dll | Mprapi.dll |