ActiveDirectoryMembershipProvider.FindUsersByName Metode

Definisi

Ruang nama:

System.Web.Security

Rakitan:

System.Web.dll

Mengembalikan kumpulan pengguna dari penyimpanan data Direktori Aktif berdasarkan nama pengguna.

public:
 override System::Web::Security::MembershipUserCollection ^ FindUsersByName(System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);

public override System.Web.Security.MembershipUserCollection FindUsersByName (string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);

override this.FindUsersByName : string * int * int * int -> System.Web.Security.MembershipUserCollection

Public Overrides Function FindUsersByName (usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As MembershipUserCollection

Parameter

usernameToMatch

String

Nama pengguna atau bagian dari nama pengguna yang akan dicari.

pageIndex

Int32

Indeks halaman hasil yang akan dikembalikan. pageIndex berbasis nol.

pageSize

Int32

Ukuran halaman hasil yang akan dikembalikan.

totalRecords

Int32

Ketika metode ini kembali, berisi jumlah total rekaman yang dikembalikan dalam koleksi. Parameter ini diteruskan tanpa diinisialisasi.

Mengembalikan

MembershipUserCollection

Instans MembershipUserCollection yang berisi pageSizeMembershipUser dimulai di halaman yang ditentukan oleh pageIndex.

Pengecualian

InvalidOperationException

Metode FindUsersByName(String, Int32, Int32, Int32) ini dipanggil sebelum instans diinisialisasi ActiveDirectoryMembershipProvider .

ArgumentException

usernameToMatch kosong, atau melebihi panjang maksimum untuk nama pengguna (biasanya 256 karakter).

-atau-

usernameToMatch berisi koma.

-atau-

pageIndex kurang dari 0.

-Atau

pageSize kurang dari 1.

-atau-

pageSize dikalikan dengan pageIndex, plus pageSize, minus 1 lebih besar dari Int32.MaxValue.

ArgumentNullException

usernameToMatchadalah null.

NotSupportedException

Properti EnableSearchMethods adalah false.

Keterangan

Metode mengembalikan FindUsersByName instans yang MembershipUserCollection berisi rekaman pengguna dari penyimpanan data Direktori Aktif untuk semua nama pengguna yang cocok dengan userNameToMatch parameter. Rekaman dikembalikan diurutkan menurut abjad menurut nama pengguna.

Hasil yang dikembalikan oleh FindUsersByName metode dibatasi oleh pageIndex parameter dan pageSize . Parameter pageSize menentukan jumlah MembershipUser maksimum instans yang akan dikembalikan di MembershipUserCollection. Parameter pageIndex menentukan halaman hasil mana yang akan dikembalikan, di mana 0 (nol) menunjukkan halaman pertama.

Parameter totalRecords adalah out parameter yang diatur ke jumlah total pengguna keanggotaan yang cocok yang ditemukan di penyimpanan data Direktori Aktif. Misalnya, jika ada 13 pengguna untuk penyimpanan data yang dikonfigurasi, dan nilainya pageIndex adalah 1 dengan pageSize 5, yang MembershipUserCollection dikembalikan akan berisi pengguna keenam hingga kesepuluh. Parameter totalRecords akan diatur ke 13.

Anda dapat mengontrol apakah akan mengizinkan pencarian pengguna, dengan mengatur EnableSearchMethods properti dalam file konfigurasi aplikasi menggunakan enableSearchMethods atribut elemen Element (ASP.NET Settings Schema) keanggotaan . EnableSearchMethods Mengatur nilai properti untuk false menyebabkan FindUsersByName metode melemparkan NotSupportedException pengecualian.

Penyedia menggunakan pencarian subtree mulai dari titik pencarian yang ditentukan dalam string koneksi. ActiveDirectoryMembershipProvider Lihat topik kelas untuk informasi selengkapnya tentang string koneksi.

Kami menyarankan agar Anda tidak mengaktifkan pencarian pada sistem produksi sampai Anda mengonfirmasi bahwa kueri pencarian yang dikeluarkan oleh ActiveDirectoryMembershipProvider kelas tidak berdampak buruk pada performa server direktori Anda. ActiveDirectoryMembershipProvider Karena kelas dirancang untuk lingkungan Web stateless, tidak dapat menggunakan pengoptimalan penomoran halaman yang diekspos oleh API yang mendasarSystem.DirectoryServices. Ini berarti bahwa operasi paging selama pencarian terhadap direktori besar sangat mahal dan harus dihindari. Operasi pencarian selalu dikeluarkan terhadap server direktori yang dikonfigurasi dalam string koneksi, atau server yang dipilih secara otomatis dalam kasus string koneksi yang menunjuk ke domain. Penyedia tidak menggunakan katalog global untuk metode pencariannya.

Lihat juga

• Pengantar Keanggotaan ASP.NET