IADsPropertyList::P urgePropertyList, méthode (iads.h)
La méthode IADsPropertyList::P urgePropertyList supprime tous les éléments de la liste de propriétés.
Syntaxe
HRESULT PurgePropertyList();
Valeur de retour
Cette méthode prend en charge les valeurs de retour HRESULT standard, y compris les S_OK. Pour plus d’informations et d’autres valeurs de retour, consultez Codes d’erreur ADSI.
Notes
Lorsque la méthode PurgePropertyList est appelée, tous les éléments sont supprimés du cache. Ainsi, l’appel de GetPropertyItem après cela génère une erreur. Sachez que PurgePropertyList affecte uniquement le contenu du cache et n’affecte pas les propriétés de l’objet réel dans le répertoire ; autrement dit, l’appel de SetInfo après l’appel de PurgePropertyList ne supprime pas les propriétés de l’objet répertoire.
Exemples
L’exemple de code suivant montre comment implémenter 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
L’exemple de code suivant montre l’effet produit par un appel à IADsPropertyList::P urgePropertyList. Pour plus d’informations sur la fonction GetPropertyCache et un exemple de code, consultez 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);
}
}
Configuration requise
| Client minimal pris en charge | Windows Vista |
| Serveur minimal pris en charge | Windows Server 2008 |
| Plateforme cible | Windows |
| En-tête | iads.h |
| DLL | Activeds.dll |