Fungsi MprAdminConnectionEnum (mprapi.h)

Artikel
08/24/2023

Fungsi MprAdminConnectionEnum menghitung semua koneksi aktif.

Sintaks

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
);

Parameter

[in] hRasServer

Tangani ke server RAS tempat koneksi dijumlahkan. Dapatkan handel ini dengan memanggil MprAdminServerConnect.

[in] dwLevel

Nilai DWORD yang menjelaskan format di mana informasi dikembalikan dalam parameter lplpbBuffer . Nilai yang dapat diterima untuk dwLevel mencakup 0, 1, 2, dan 3, seperti yang tercantum dalam tabel berikut.

Windows NT 4.0: Parameter ini harus nol.

Nilai	Format Struktur
0	RAS_CONNECTION_0
1	Windows 2000 atau yang lebih baru: RAS_CONNECTION_1
2	Windows 2000 atau yang lebih baru: RAS_CONNECTION_2
3	Windows Server 2008 atau yang lebih baru: RAS_CONNECTION_3

[out] lplpbBuffer

Setelah berhasil diselesaikan, penunjuk ke array struktur yang menjelaskan koneksi. Struktur ini berjenis RAS_CONNECTION_0, RAS_CONNECTION_1, RAS_CONNECTION_2, atau RAS_CONNECTION_3, tergantung pada nilai parameter dwLevel .

Untuk membebaskan memori ini, panggil MprAdminBufferFree.

[in] dwPrefMaxLen

Menentukan panjang maksimum yang disukai dari data yang dikembalikan dalam byte 8-bit. Jika dwPrefMaxLen adalah -1, buffer yang dikembalikan cukup besar untuk menyimpan semua informasi yang tersedia.

[out] lpdwEntriesRead

Penunjuk ke variabel DWORD . Variabel ini menerima jumlah total koneksi yang dijumlahkan dari posisi resume saat ini.

[out] lpdwTotalEntries

Penunjuk ke variabel DWORD . Variabel ini menerima jumlah total koneksi yang dapat dijumlahkan dari posisi resume saat ini.

[in] lpdwResumeHandle

Penunjuk ke variabel DWORD . Variabel ini menentukan handel resume yang digunakan untuk melanjutkan enumerasi. Parameter lpdwResumeHandle adalah nol pada panggilan pertama, dan dibiarkan tidak berubah pada panggilan berikutnya. Jika kode pengembalian ERROR_MORE_DATA, panggilan lain dapat dilakukan menggunakan handel ini untuk mengambil lebih banyak data. Jika handel adalah NULL saat dikembalikan, enumerasi selesai. 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 berikut.

Nilai	Makna
ERROR_DDM_NOT_RUNNING	Demand Dial Manager (DDM) tidak berjalan, mungkin karena Dynamic Interface Manager (DIM) dikonfigurasi untuk hanya berjalan pada LAN.
ERROR_INVALID_LEVEL	Nilai yang diteruskan untuk dwLevel bukan nol, satu, dua, atau tiga. Tingkat satu dan dua hanya didukung pada Windows 2000 atau yang lebih baru. Tingkat tiga hanya didukung pada Windows Server 2008 atau yang lebih baru.
ERROR_INVALID_PARAMETER	Setidaknya salah satu parameter berikut adalah NULL atau tidak menunjuk ke memori yang valid: lplpBuffer, lpdwEntriesRead, atau lpdwTotalEntries.
ERROR_MORE_DATA	Tidak semua data dikembalikan dengan panggilan ini. Untuk mendapatkan data tambahan, panggil fungsi lagi menggunakan handel resume.
RPC_S_INVALID_BINDING	Handel yang diteruskan dalam parameter hRasServer adalah NULL atau tidak valid.
Lainnya	Kesalahan dari MprError.h, RasError.h, atau WinError.h.

Keterangan

Fungsi ini tersedia di Windows NT 4.0 jika RRAS redistributable diinstal. Namun, versi Mprapi.dll yang dikirim dengan RRAS redistributable mengekspor fungsi sebagai RasAdminConnectionEnum daripada MprAdminConnectionEnum. Oleh karena itu, saat menggunakan RRAS yang dapat didistribusikan ulang, 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