ADS_STATUSENUM enumeração (iads.h)

Artigo
02/28/2024

A enumeração ADS_STATUSENUM especifica o status de um conjunto de preferências de pesquisa com o 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 A preferência de pesquisa foi definida com êxito.
`ADS_STATUS_INVALID_SEARCHPREF` A preferência de pesquisa especificada no membro dwSearchPref da estrutura ADS_SEARCHPREF_INFO é inválida. As preferências de pesquisa devem ser obtidas da enumeração ADS_SEARCHPREF_ENUM .
`ADS_STATUS_INVALID_SEARCHPREFVALUE` O valor especificado no membro vValue da estrutura ADS_SEARCHPREF_INFO é inválido para a preferência de pesquisa correspondente.

Comentários

O método IDirectorySearch::SetSearchPreference define o membro dwStatusADS_SEARCHPREF_INFO estrutura como um dos valores ADS_STATUSENUM para indicar o status da preferência de pesquisa correspondente. Os chamadores podem usar esse valor status para decidir se devem executar uma pesquisa.

O ADS_STATUS_INVALID_SEARCHPREF valor status pode ser definido se você definir uma preferência de pesquisa válida, mas essa preferência não é compatível. Por exemplo, se você definir ADS_SEARCHPREF_SORT_ON, mas o servidor com o qual você se comunica não oferecer suporte ao controle de classificação do lado do servidor LDAP, o membro dwStatus da estrutura ADS_SEARCHPREF_INFO será definido como ADS_STATUS_INVALID_SEARCHPREF pela chamada IDirectorySearch::SetSearchPreference .

Nota Como o VBScript não pode ler dados de uma biblioteca de tipos, os aplicativos VBScript não reconhecem as constantes simbólicas, conforme definido acima. Em vez disso, você deve usar as constantes numéricas para definir os sinalizadores apropriados em seus aplicativos VBScript. Para usar as constantes simbólicas como uma boa prática de programação, escreva declarações explícitas dessas constantes, conforme feito no exemplo de código a seguir.

Exemplos

O exemplo de código a seguir mostra como usar a enumeração ADS_STATUSENUM com o método IDirectorySearch::SetSearchPreference para determinar o status de uma preferência de pesquisa.

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

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