IADsPropertyList::P urgePropertyList-Methode (iads.h)

Die IADsPropertyList::P urgePropertyList-Methode löscht alle Elemente aus der Eigenschaftenliste.

Syntax

HRESULT PurgePropertyList();

Rückgabewert

Diese Methode unterstützt die HRESULT-Standardrückgabewerte, einschließlich S_OK. Weitere Informationen und andere Rückgabewerte finden Sie unter ADSI-Fehlercodes.

Hinweise

Wenn die PurgePropertyList-Methode aufgerufen wird, werden alle Elemente aus dem Cache entfernt. Wenn Sie getPropertyItem danach aufrufen, wird daher ein Fehler generiert. Beachten Sie, dass PurgePropertyList nur den Inhalt des Caches und nicht die Eigenschaften des tatsächlichen Objekts im Verzeichnis beeinflusst. Das heißt, das Aufrufen von SetInfo nach dem Aufrufen von PurgePropertyList löscht die Eigenschaften für das Verzeichnisobjekt nicht.

Beispiele

Das folgende Codebeispiel zeigt, wie Sie IADsPropertyList::P urgePropertyList implementieren.

Dim propList As IADsPropertyList
 
On Error GoTo Cleanup

Set propList = GetObject("LDAP://dc03/DC=Fabrikam,DC=com")
propList.GetInfo
 
propList.PurgePropertyList
 
'- None of GetPropertyItem should work, because the list is purged.
'- The following line should generate error.
Set propEntry = propList.GetPropertyItem("adminDescription", ADSTYPE_CASE_IGNORE_STRING)

Cleanup:
    If (Err.Number<>0) Then
        MsgBox("An error has occurred. " & Err.Number)
    End If

    Set propList = Nothing

Das folgende Codebeispiel zeigt den Effekt, der durch einen Aufruf von IADsPropertyList::P urgePropertyList erzeugt wird. Weitere Informationen zur GetPropertyCache-Funktion und ein Codebeispiel finden Sie unter IADsPropertyList.

IADsPropertyList *GetPropertyCache(LPWSTR);
 
void TestPurgePropertyList()
{
    IADsPropertyList *pList;
    pList=GetPropertyCache(L"WinNT://myComputer,computer");
 
    long count;

    if(pList)
    {
        pList->get_PropertyCount(&count);
        printf("Number of properties before purging: %d\n",count);
 
        count = -1;
        pList->PurgePropertyList();
        pList->get_PropertyCount(&count);
        printf("Number of properties after purging: %d\n",count);
    }
}

Anforderungen

Unterstützte Mindestversion (Client)	Windows Vista
Unterstützte Mindestversion (Server)	Windows Server 2008
Zielplattform	Windows
Kopfzeile	iads.h
DLL	Activeds.dll

Weitere Informationen

ADSI-Fehlercodes

IADsPropertyList

Methoden der IADsPropertyList-Eigenschaft

IADsPropertyList::GetPropertyItem