Fungsi MprAdminConnectionEnumEx (mprapi.h)

Artikel
02/29/2024

Fungsi MprAdminConnectionEnumEx menghitung koneksi aktif untuk server RRAS tertentu.

Sintaks

DWORD MprAdminConnectionEnumEx(
  [in]  RAS_SERVER_HANDLE     hRasServer,
  [in]  PMPRAPI_OBJECT_HEADER pObjectHeader,
  [in]  DWORD                 dwPreferedMaxLen,
  [out] LPDWORD               lpdwEntriesRead,
  [out] LPDWORD               lpdwTotalEntries,
  [out] PRAS_CONNECTION_EX    *ppRasConn,
  [in]  LPDWORD               lpdwResumeHandle
);

Parameter

[in] hRasServer

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

[in] pObjectHeader

Penunjuk ke struktur MPRAPI_OBJECT_HEADER yang menentukan versi struktur yang diterima oleh ppRasConn.

[in] dwPreferedMaxLen

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

[out] lpdwEntriesRead

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

[out] lpdwTotalEntries

Pointer ke DWORD yang menerima jumlah total koneksi yang dapat dijumlahkan dari posisi resume saat ini.

[out] ppRasConn

Penunjuk, pada output, ke array struktur RAS_CONNECTION_EX yang berisi informasi koneksi aktif untuk server RRAS di hRasServer. Jumlah elemen array ditentukan oleh nilai yang diarahkan oleh lpdwEntriesRead.

[in] lpdwResumeHandle

Penunjuk ke variabel DWORD yang menentukan handel resume yang digunakan untuk melanjutkan enumerasi. Parameter lpdwResumeHandle adalah NULL 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 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_ACCESS_DENIED	Aplikasi panggilan tidak memiliki hak istimewa yang memadai.
ERROR_DDM_NOT_RUNNING	Manajer Putar Nomor Permintaan (DDM) tidak berjalan.
ERROR_MORE_DATA	Tidak semua data dikembalikan dengan panggilan ini. Untuk mendapatkan data tambahan, panggil fungsi lagi menggunakan handel resume.
ERROR_PROC_NOT_FOUND	Prosedur yang ditentukan tidak dapat ditemukan.
Lainnya	Kesalahan dari MprError.h, RasError.h, atau WinError.h.

Keterangan

Pemanggil harus membebaskan memori yang diacu oleh ppRasConn dengan memanggil fungsi MprAdminBufferFree.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 7 [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 R2 [hanya aplikasi desktop]
Target Platform	Windows
Header	mprapi.h
Pustaka	Mprapi.lib
DLL	Mprapi.dll