enumerazione ADS_STATUSENUM (iads.h)

Articolo
03/13/2024

L'enumerazione ADS_STATUSENUM specifica lo stato di un set di preferenze di ricerca con il metodo IDirectorySearch::SetSearchPreference.

Sintassi

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

Costanti


`ADS_STATUS_S_OK` Valore: 0 La preferenza di ricerca è stata impostata correttamente.
`ADS_STATUS_INVALID_SEARCHPREF` La preferenza di ricerca specificata nel membro dwSearchPref della struttura di ADS_SEARCHPREF_INFO non è valida. Le preferenze di ricerca devono essere prese dall'enumerazione ADS_SEARCHPREF_ENUM .
`ADS_STATUS_INVALID_SEARCHPREFVALUE` Il valore specificato nel membro vValue della struttura ADS_SEARCHPREF_INFO non è valido per la preferenza di ricerca corrispondente.

Commenti

Il metodo IDirectorySearch::SetSearchPreference imposta la struttura membro dwStatus ADS_SEARCHPREF_INFO su uno dei valoriADS_STATUSENUM per indicare lo stato della preferenza di ricerca corrispondente. I chiamanti possono usare questo valore di stato per decidere se eseguire una ricerca.

Il valore di stato ADS_STATUS_INVALID_SEARCHPREF può essere impostato se si imposta una preferenza di ricerca valida, ma tale preferenza non è supportata. Ad esempio, se si imposta ADS_SEARCHPREF_SORT_ON, ma il server con cui si comunica non supporta il controllo ordinamento lato server LDAP, il membro dwStatusdella struttura ADS_SEARCHPREF_INFO è impostato su ADS_STATUS_INVALID_SEARCHPREF dalla chiamata IDirectorySearch::SetSearchPreference .

Nota Poiché VBScript non riesce a leggere i dati da una libreria di tipi, le applicazioni VBScript non riconoscono le costanti simboliche definite in precedenza. È consigliabile usare le costanti numeriche per impostare i flag appropriati nelle applicazioni VBScript. Per usare le costanti simboliche come una buona procedura di programmazione, scrivere dichiarazioni esplicite di tali costanti, come fatto nell'esempio di codice seguente.

Esempio

Nell'esempio di codice seguente viene illustrato come usare l'enumerazione ADS_STATUSENUM con il metodo IDirectorySearch::SetSearchPreference per determinare lo stato di una preferenza di ricerca.

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

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