Fungsi MprAdminPortEnum (mprapi.h)
Fungsi MprAdminPortEnum menghitung semua port aktif dalam koneksi tertentu, atau semua port yang tersedia untuk digunakan atau saat ini digunakan oleh RAS.
Sintaks
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
);
Parameter
[in] hRasServer
Handel ke server RAS yang portnya akan dijumlahkan. Untuk mendapatkan handel ini, panggil MprAdminServerConnect.
[in] dwLevel
Nilai DWORD yang menjelaskan format di mana informasi dikembalikan dalam parameter lplpbBuffer . Harus nol.
[in] hRasConnection
Handel ke koneksi tempat port aktif dijumlahkan. Jika parameter ini INVALID_HANDLE_VALUE, semua port yang digunakan atau tersedia untuk digunakan oleh RRAS dijumlahkan. Untuk mendapatkan handel ini, panggil MprAdminConnectionEnum.
[out] lplpbBuffer
Setelah berhasil diselesaikan, penunjuk ke array struktur RAS_PORT_0 yang menjelaskan port. Bebaskan memori ini dengan memanggil MprAdminBufferFree.
[in] dwPrefMaxLen
Nilai yang menentukan panjang maksimum data yang dikembalikan, dalam byte 8-bit. Jika parameter ini adalah -1, buffer yang dikembalikan cukup besar untuk menyimpan semua data yang tersedia.
[out] lpdwEntriesRead
Penunjuk ke variabel DWORD . Variabel ini menerima jumlah total port yang dijumlahkan dari posisi resume saat ini.
[out] lpdwTotalEntries
Penunjuk ke variabel DWORD . Variabel ini menerima jumlah total port yang dapat dijumlahkan dari posisi resume saat ini.
[in] lpdwResumeHandle
Penunjuk ke variabel DWORD . Pada eksekusi yang berhasil, parameter ini menentukan handel yang dapat digunakan untuk melanjutkan enumerasi. Parameter ini harus nol pada panggilan pertama dan dibiarkan tidak berubah pada panggilan berikutnya. Jika kode pengembalian ERROR_MORE_DATA, panggilan dapat diterbitkan kembali dengan handel untuk mengambil lebih banyak data. Jika handel adalah NULL saat dikembalikan, enumerasi tidak dapat dilanjutkan. Handel ini tidak valid untuk jenis pengembalian kesalahan lainnya.
Nilai kembali
Jika fungsi berhasil, nilai yang dikembalikan adalah NO_ERROR.
Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan yang tercantum dalam tabel berikut.
Nilai | Makna |
---|---|
|
Aplikasi panggilan tidak memiliki hak istimewa yang memadai. |
|
Demand Dial Manager (DDM) tidak berjalan, mungkin karena Dynamic Interface Manager (DIM) dikonfigurasi untuk berjalan hanya pada LAN. |
|
Setidaknya salah satu parameter berikut adalah NULL atau tidak menunjuk ke memori yang valid: lplpBuffer, lpdwEntriesRead, atau lpdwTotalEntries. |
|
Tidak semua data dikembalikan dengan panggilan ini. Untuk mendapatkan data tambahan, panggil fungsi lagi menggunakan handel yang dikembalikan dalam parameter IpdwResumeHandle . |
|
Parameter dwLevel bukan nol. |
|
Parameter hConnection adalah NULL. |
|
Kesalahan dari MprError.h, RasError.h, atau WinError.h. |
Keterangan
Jika RRAS redistributable diinstal, fungsi ini tersedia di Windows NT 4.0. Namun, versi Mprapi.dll yang disediakan dengan RRAS redistributable mengekspor fungsi sebagai RasAdminPortEnum daripada MprAdminPortEnum. Oleh karena itu, saat menggunakan RRAS redistributable, gunakan LoadLibrary dan GetProcAddress untuk mengakses fungsi ini.
Persyaratan
Persyaratan | Nilai |
---|---|
Klien minimum yang didukung | Windows 2000 Professional [hanya aplikasi desktop] |
Server minimum yang didukung | Windows 2000 Server [hanya aplikasi desktop] |
Target Platform | Windows |
Header | mprapi.h |
Pustaka | Mprapi.lib |
DLL | Mprapi.dll |