Platform SDK: Active Directory, ADSI, and Directory Services

IDirectoryObject::SetObjectAttributes

The IDirectoryObject::SetObjectAttributes method modifies the information of one or more specified attributes of the directory service object, as defined in the ADS_ATTR_INFO structure.

HRESULT SetObjectAttributes(
  PADS_ATTR_INFO pAttributeEntries,
  DWORD dwNumberAttributes, 
  DWORD * pdwNumAttributesModified
);

Parameters

pAttributeEntries: [in] Provides an array of attributes to be modified. Each attribute contains the name of the attribute, the operation to perform on it, and the attribute value, if applicable. For more information, see the ADS_ATTR_INFO structure.
dwNumberAttributes: [in] Provides the number of attributes to be modified. This value should correspond to the size of the pAttributeEntries array.
pdwNumAttributesModified: [out] Provides a pointer to a DWORD variable that contains the number of attributes modified by the SetObjectAttributes method.

Return Values

This method returns the standard return values, including S_OK when the attributes are set successfully.

For other return values, see ADSI Error Codes.

Remarks

In Active Directory™ (LDAP provider), the IDirectoryObject::SetObjectAttributes method is a transacted call. The attributes are either all committed or discarded. Other directory providers may not transact the call.

Example Code [C++]

The following C++ code snippet sets the "sn" attribute of a user object to the value of "William" as a case insensitive string.

HRESULT    hr;
IDirectoryObject *pDirObject=NULL;
DWORD  dwReturn;
 ADSVALUE  snValue;
 ADS_ATTR_INFO  attrInfo[] = {   {L"sn",ADS_ATTR_UPDATE,ADSTYPE_CASE_IGNORE_STRING,&snValue,1} };
DWORD dwAttrs = sizeof(attrInfo)/sizeof(ADS_ATTR_INFO); 
 
snValue.dwType=ADSTYPE_CASE_IGNORE_STRING;
snValue.CaseIgnoreString = L"William";
 
hr = ADsGetObject(L"LDAP://CN=David Johnson,OU=Sales,DC=Microsoft,DC=com",
        IID_IDirectoryObject, 
        (void**) &pDirObject );
 
   if ( SUCCEEDED(hr) )
   {
    hr=pDirObject->SetObjectAttributes(attrInfo, dwAttrs, &dwReturn);
   }
pDirObject->Release();

Requirements