ADS_STATUSENUM-Enumeration (iads.h)

Artikel
08/24/2023

Die ADS_STATUSENUM-Enumeration gibt die status einer Sucheinstellung an, die mit der IDirectorySearch::SetSearchPreference-Methode festgelegt wurde.

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;

Konstanten


`ADS_STATUS_S_OK` Wert: 0 Die Sucheinstellung wurde erfolgreich festgelegt.
`ADS_STATUS_INVALID_SEARCHPREF` Die im dwSearchPref-Element der ADS_SEARCHPREF_INFO-Struktur angegebene Sucheinstellung ist ungültig. Sucheinstellungen müssen der ADS_SEARCHPREF_ENUM-Enumeration entnommen werden.
`ADS_STATUS_INVALID_SEARCHPREFVALUE` Der im vValue-Member der ADS_SEARCHPREF_INFO-Struktur angegebene Wert ist für die entsprechende Sucheinstellung ungültig.

Hinweise

Die IDirectorySearch::SetSearchPreference-Methode legt den dwStatus-MemberADS_SEARCHPREF_INFO-Struktur auf einen der ADS_STATUSENUM-Werte fest, um die status der entsprechenden Sucheinstellung anzugeben. Aufrufer können diesen status Wert verwenden, um zu entscheiden, ob eine Suche ausgeführt werden soll.

Der ADS_STATUS_INVALID_SEARCHPREF status Wert kann festgelegt werden, wenn Sie eine gültige Sucheinstellung festlegen, aber diese Einstellung wird nicht unterstützt. Wenn Sie beispielsweise ADS_SEARCHPREF_SORT_ON festlegen, aber der Server, mit dem Sie kommunizieren, das serverseitige LDAP-Sortiersteuerelement nicht unterstützt, wird der dwStatus-Member der ADS_SEARCHPREF_INFO-Struktur durch den IDirectorySearch::SetSearchPreference-Aufruf auf ADS_STATUS_INVALID_SEARCHPREF festgelegt.

Hinweis Da VBScript keine Daten aus einer Typbibliothek lesen kann, erkennen VBScript-Anwendungen die oben definierten symbolischen Konstanten nicht. Sie sollten stattdessen die numerischen Konstanten verwenden, um die entsprechenden Flags in Ihren VBScript-Anwendungen festzulegen. Um die symbolischen Konstanten als bewährte Programmierpraxis zu verwenden, schreiben Sie explizite Deklarationen solcher Konstanten, wie im folgenden Codebeispiel beschrieben.

Beispiele

Im folgenden Codebeispiel wird gezeigt, wie die ADS_STATUSENUM-Enumeration mit der IDirectorySearch::SetSearchPreference-Methode verwendet wird, um die status einer Sucheinstellung zu bestimmen.

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

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