перечисление ADS_STATUSENUM (iads.h)

Статья
08/24/2023

Перечисление ADS_STATUSENUM указывает состояние набора параметров поиска с помощью метода IDirectorySearch::SetSearchPreference .

Синтаксис

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

Константы


`ADS_STATUS_S_OK` Значение: 0 Предпочтения поиска успешно заданы.
`ADS_STATUS_INVALID_SEARCHPREF` Предпочтения поиска, указанные в элементе dwSearchPrefструктуры ADS_SEARCHPREF_INFO , недопустимы. Параметры поиска должны быть взяты из перечисления ADS_SEARCHPREF_ENUM .
`ADS_STATUS_INVALID_SEARCHPREFVALUE` Значение, указанное в элементе vValueструктуры ADS_SEARCHPREF_INFO , недопустимо для соответствующих предпочтений поиска.

Метод IDirectorySearch::SetSearchPreference задает элементу dwStatusADS_SEARCHPREF_INFO структуру одного из ADS_STATUSENUM значений, чтобы указать состояние соответствующего предпочтения поиска. Вызывающие абоненты могут использовать это значение состояния, чтобы решить, следует ли выполнять поиск.

Значение состояния ADS_STATUS_INVALID_SEARCHPREF может быть задано, если задан допустимый параметр поиска, но этот параметр не поддерживается. Например, если задано ADS_SEARCHPREF_SORT_ON, но сервер, с которым вы взаимодействуете, не поддерживает элемент управления сортировкой на стороне сервера LDAP, члену dwStatusструктуры ADS_SEARCHPREF_INFO присваивается значение ADS_STATUS_INVALID_SEARCHPREF с помощью вызова IDirectorySearch::SetSearchPreference .

Примечание Так как VBScript не может считывать данные из библиотеки типов, приложения VBScript не распознают символьные константы, как определено выше. Вместо этого следует использовать числовые константы, чтобы задать соответствующие флаги в приложениях VBScript. Чтобы использовать символьные константы в качестве рекомендуемой практики программирования, напишите явные объявления таких констант, как показано в следующем примере кода.

Примеры

В следующем примере кода показано, как использовать перечисление ADS_STATUSENUM с методом IDirectorySearch::SetSearchPreference для определения состояния предпочтения поиска.

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

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

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Верхняя часть	iads.h

См. также раздел

Перечисления ADSI

ADS_SEARCHPREF_ENUM

ADS_SEARCHPREF_INFO

IDirectorySearch::SetSearchPreference

Поделиться через