IADsPropertyList interface

Applies to: desktop apps only

The IADsPropertyList interface is used to modify, read, and update a list of property entries in the property cache of an object. It serves to enumerate, modify, and purge the contained property entries. Use the enumeration method of this interface to identify initialized properties. This is different from using the schema to determine all possible attributes that an ADSI object can have and which properties have been set.

Call the methods of the IADsPropertyList interface to examine and manipulate the property list on the client. Before calling the methods of this interface, you must call IADs::GetInfo or IADs::GetInfoEx explicitly to load the assigned property values of the object into the cache. After calling the methods of this interface, you must call IADs::SetInfo to save the changes in the persistent store of the underlying directory.

To obtain the property list of an ADSI object, bind to its IADsPropertyList interface. You must call the GetInfo method before calling other methods of property list object, if the property cache has not been initialized.

Members

The IADsPropertyList interface inherits from the IDispatch interface. IADsPropertyList also has these types of members:

• Methods
• Properties

Methods

The IADsPropertyList interface has these methods.

Properties

The IADsPropertyList interface has these properties.

Example Code

The following code example shows how to bind to the IADsPropertyList interface and then initialize the property cache.

Dim pList as IADsPropertyList
On Error GoTo Cleanup

Set pList = GetObject("LDAP://dc01/dc=Fabrikam,dc=com")
pList.GetInfo

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

The following code example shows how to bind to the IADsPropertyList interface and initialize the property cache.

IADsPropertyList* GetPropertyCache(LPWSTR adsPath)
{
    IADsPropertyList *pList;
    IADs *pObj;
    if(!adsPath)
    {
        _tprintf(TEXT("Invalid ADsPath."));
        return NULL;
    }

    HRESULT hr = ADsGetObject(adsPath,
                          IID_IADsPropertyList,
                          (void**)&pList);
    // Initialize the property cache.
    hr = pList->QueryInterface(IID_IADs,(void**)&pObj);
    pObj->GetInfo();
    pObj->Release();

    return pList;
}

Requirements

See also

IADs::GetInfo

IADs::GetInfoEx

IADs::SetInfo

IADsPropertyList Property Methods

IDispatch

Send comments about this topic to Microsoft

Build date: 2/3/2012