énumération ADS_STATUSENUM (iads.h)

Article
03/01/2024

L’énumération ADS_STATUSENUM spécifie la status d’un ensemble de préférences de recherche avec la méthode IDirectorySearch ::SetSearchPreference.

Syntax

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

Constantes


`ADS_STATUS_S_OK` Valeur : 0 La préférence de recherche a été définie avec succès.
`ADS_STATUS_INVALID_SEARCHPREF` La préférence de recherche spécifiée dans le membre dwSearchPref de la structure ADS_SEARCHPREF_INFO n’est pas valide. Les préférences de recherche doivent être extraites de l’énumération ADS_SEARCHPREF_ENUM .
`ADS_STATUS_INVALID_SEARCHPREFVALUE` La valeur spécifiée dans le membre vValue de la structure ADS_SEARCHPREF_INFO n’est pas valide pour la préférence de recherche correspondante.

Remarques

La méthode IDirectorySearch ::SetSearchPreference définit le membre dwStatusADS_SEARCHPREF_INFO structure sur l’une des valeurs ADS_STATUSENUM pour indiquer la status de la préférence de recherche correspondante. Les appelants peuvent utiliser cette valeur status pour décider s’il faut exécuter une recherche.

La valeur ADS_STATUS_INVALID_SEARCHPREF status peut être définie si vous définissez une préférence de recherche valide, mais cette préférence n’est pas prise en charge. Par exemple, si vous définissez ADS_SEARCHPREF_SORT_ON, mais que le serveur avec lequel vous communiquez ne prend pas en charge le contrôle de tri côté serveur LDAP, le membre dwStatus de la structure ADS_SEARCHPREF_INFO est défini sur ADS_STATUS_INVALID_SEARCHPREF par l’appel IDirectorySearch ::SetSearchPreference .

Note Étant donné que VBScript ne peut pas lire les données d’une bibliothèque de types, les applications VBScript ne reconnaissent pas les constantes symboliques telles que définies ci-dessus. Vous devez utiliser les constantes numériques à la place pour définir les indicateurs appropriés dans vos applications VBScript. Pour utiliser les constantes symboliques comme bonne pratique de programmation, écrivez des déclarations explicites de telles constantes, comme fait dans l’exemple de code suivant.

Exemples

L’exemple de code suivant montre comment utiliser l’énumération ADS_STATUSENUM avec la méthode IDirectorySearch ::SetSearchPreference pour déterminer le status d’une préférence de recherche.

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

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