enumeración ADS_STATUSENUM (iads.h)

Artículo
08/24/2023

La enumeración ADS_STATUSENUM especifica el estado de un conjunto de preferencias de búsqueda con el método 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` Valor: 0 La preferencia de búsqueda se estableció correctamente.
`ADS_STATUS_INVALID_SEARCHPREF` La preferencia de búsqueda especificada en el miembro dwSearchPref de la estructura ADS_SEARCHPREF_INFO no es válida. Las preferencias de búsqueda se deben tomar de la enumeración ADS_SEARCHPREF_ENUM .
`ADS_STATUS_INVALID_SEARCHPREFVALUE` El valor especificado en el miembro vValue de la estructura ADS_SEARCHPREF_INFO no es válido para la preferencia de búsqueda correspondiente.

Comentarios

El método IDirectorySearch::SetSearchPreference establece el miembro dwStatusADS_SEARCHPREF_INFO estructura en uno de los valores de ADS_STATUSENUM para indicar el estado de la preferencia de búsqueda correspondiente. Los autores de llamadas pueden usar este valor de estado para decidir si se debe ejecutar una búsqueda.

El valor de estado ADS_STATUS_INVALID_SEARCHPREF se puede establecer si establece una preferencia de búsqueda válida, pero no se admite esa preferencia. Por ejemplo, si establece ADS_SEARCHPREF_SORT_ON, pero el servidor con el que se comunica no admite el control de ordenación del lado servidor LDAP, el miembro dwStatus de la estructura de ADS_SEARCHPREF_INFO se establece en ADS_STATUS_INVALID_SEARCHPREF mediante la llamada a IDirectorySearch::SetSearchPreference .

Nota Dado que VBScript no puede leer datos de una biblioteca de tipos, las aplicaciones vbScript no reconocen las constantes simbólicas como se ha definido anteriormente. En su lugar, debe usar las constantes numéricas para establecer las marcas adecuadas en las aplicaciones VBScript. Para usar las constantes simbólicas como práctica de programación recomendada, escriba declaraciones explícitas de estas constantes, como se hace en el ejemplo de código siguiente.

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar la enumeración ADS_STATUSENUM con el método IDirectorySearch::SetSearchPreference para determinar el estado de una preferencia de búsqueda.

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

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