IADsPropertyList：:P urgePropertyList 方法 (iads.h)

發行項
08/24/2023

IADsPropertyList：:P urgePropertyList方法會從屬性清單中刪除所有專案。

Syntax

HRESULT PurgePropertyList();

傳回值

這個方法支援標準 HRESULT 傳回值，包括S_OK。如需詳細資訊和其他傳回值，請參閱 ADSI 錯誤碼。

備註

呼叫 PurgePropertyList 方法時，所有專案都會從快取中移除。因此，在該之後呼叫 GetPropertyItem 將會產生錯誤。請注意，PurgePropertyList只會影響快取的內容，而且不會影響目錄中實際物件的屬性;也就是說，呼叫PurgePropertyList之後呼叫SetInfo並不會刪除目錄物件上的屬性。

範例

下列程式碼範例示範如何實作 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);
    }
}