enumerasi ADS_STATUSENUM (iads.h)

Artikel
08/24/2023

Enumerasi ADS_STATUSENUM menentukan status preferensi pencarian yang diatur dengan metode IDirectorySearch::SetSearchPreference .

Sintaks

typedef enum __MIDL___MIDL_itf_ads_0000_0000_0019 {
  ADS_STATUS_S_OK = 0,
  ADS_STATUS_INVALID_SEARCHPREF,
  ADS_STATUS_INVALID_SEARCHPREFVALUE
} ADS_STATUSENUM;

Konstanta


`ADS_STATUS_S_OK` Nilai: 0 Preferensi pencarian berhasil disetel.
`ADS_STATUS_INVALID_SEARCHPREF` Preferensi pencarian yang ditentukan dalam anggota dwSearchPref dari struktur ADS_SEARCHPREF_INFO tidak valid. Preferensi pencarian harus diambil dari enumerasi ADS_SEARCHPREF_ENUM .
`ADS_STATUS_INVALID_SEARCHPREFVALUE` Nilai yang ditentukan dalam anggota vValue dari struktur ADS_SEARCHPREF_INFO tidak valid untuk preferensi pencarian yang sesuai.

Keterangan

Metode IDirectorySearch::SetSearchPreference mengatur anggota dwStatusADS_SEARCHPREF_INFO struktur ke salah satu nilai ADS_STATUSENUM untuk menunjukkan status preferensi pencarian yang sesuai. Penelepon dapat menggunakan nilai status ini untuk memutuskan apakah akan menjalankan pencarian.

Nilai status ADS_STATUS_INVALID_SEARCHPREF dapat diatur jika Anda mengatur preferensi pencarian yang valid, tetapi preferensi tersebut tidak didukung. Misalnya, jika Anda mengatur ADS_SEARCHPREF_SORT_ON, tetapi server yang Anda komunikasikan tidak mendukung kontrol pengurutan sisi server LDAP, anggota dwStatus dari struktur ADS_SEARCHPREF_INFO diatur ke ADS_STATUS_INVALID_SEARCHPREF oleh panggilan IDirectorySearch::SetSearchPreference .

Catatan Karena VBScript tidak dapat membaca data dari pustaka jenis, aplikasi VBScript tidak mengenali konstanta simbolis seperti yang ditentukan di atas. Anda harus menggunakan konstanta numerik sebagai gantinya untuk mengatur bendera yang sesuai di aplikasi VBScript Anda. Untuk menggunakan konstanta simbolis sebagai praktik pemrograman yang baik, tulis deklarasi eksplisit konstanta tersebut, seperti yang dilakukan dalam contoh kode berikut.

Contoh

Contoh kode berikut menunjukkan cara menggunakan enumerasi ADS_STATUSENUM dengan metode IDirectorySearch::SetSearchPreference untuk menentukan status preferensi pencarian.

/***************************************************************************

    SetAndCheckSearchTimeout()

***************************************************************************/

HRESULT SetAndCheckSearchTimeout(IDirectorySearch *pSearch, 
                                 DWORD dwTimeout, 
                                 ADS_STATUSENUM *pStatus)
{
    if(!pSearch || !pStatus)
    {
        return E_INVALIDARG;
    }
    
    HRESULT hr;
    ADS_SEARCHPREF_INFO SearchPref;

    SearchPref.dwSearchPref = ADS_SEARCHPREF_TIMEOUT;
    SearchPref.vValue.dwType = ADSTYPE_INTEGER;
    SearchPref.vValue.Integer = dwTimeout;
    SearchPref.dwStatus = ADS_STATUS_S_OK;

    hr = pSearch->SetSearchPreference(&SearchPref, 1);
    if(S_OK != hr)
    {
        return hr;
    }

    *pStatus = SearchPref.dwStatus;
    return S_OK;
}