Метод IADsPropertyList::P urgePropertyList (iads.h)

Статья
08/24/2023

Метод IADsPropertyList::P urgePropertyList удаляет все элементы из списка свойств.

Синтаксис

HRESULT PurgePropertyList();

Возвращаемое значение

Этот метод поддерживает стандартные возвращаемые значения HRESULT, включая S_OK. Дополнительные сведения и другие возвращаемые значения см. в разделе Коды ошибок ADSI.

При вызове метода PurgePropertyList все элементы удаляются из кэша. Таким образом, вызов GetPropertyItem после этого приведет к ошибке. Имейте в виду, что PurgePropertyList влияет только на содержимое кэша и не влияет на свойства фактического объекта в каталоге; то есть вызов SetInfo после вызова PurgePropertyList не удаляет свойства объекта каталога.

Примеры

В следующем примере кода показано, как реализовать IADsPropertyList::P urgePropertyList.

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

В следующем примере кода показан эффект, полученный при вызове IADsPropertyList::P urgePropertyList. Дополнительные сведения о функции GetPropertyCache и пример кода см. в разделе 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);
    }
}

Требования


Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Целевая платформа	Windows
Header	iads.h
DLL	Activeds.dll

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

Коды ошибок ADSI

IADsPropertyList

Методы свойств IADsPropertyList

IADsPropertyList::GetPropertyItem

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