IAdmSetPropertiesAction

The IAdmSetPropertiesAction interface represents the Update object action.

Inheritance: IAdmAction

Methods

Properties

  • Property

  • Description

  • PropertyList

  • Gets a property list that contains information about property modifications performed by this action.

Details

GetModificationDescriptionXml()

Gets the description of a specific property modification.

string GetModificationDescriptionXml(IADsPropertyEntry entry, int mask = 0)

Parameters

  • entry – The property entry to get the modification description for.
  • mask – A bitmask that specifies which bits of the property value will be changed. This parameter should be specified only if you need to obtain the modification description for a flag-based integer property. For example, Account options. To obtain the required mask value, call IAdmPropertyList::GetPropertyItemMask.

Examples

The following code sample gets the modification description for the Account options property.

Powershell
# The $action variable contains the IAdmSetPropertiesAction interface 

$propertyList = $action.PropertyList
$entry = $propertyList.GetPropertyItem("userAccountControl", "ADSTYPE_INTEGER")
$mask = $propertyList.GetPropertyItemMask("userAccountControl")
$description = $action.GetModificationDescriptionXml($entry, $mask)
C#
// The action variable contains the IAdmSetPropertiesAction interface 

IADsPropertyList propertyList = action.PropertyList;
IADsPropertyEntry entry = (IADsPropertyEntry)propertyList.GetPropertyItem(
    "userAccountControl", ADSTYPEENUM.ADSTYPE_INTEGER);

IAdmPropertyList propertyList2 = (IAdmPropertyList)action.PropertyList;
int mask = propertyList2.GetPropertyItemMask("userAccountControl");
string description = action.GetModificationDescriptionXml(entry, mask);

PropertyList

Gets a property list that contains information about property modifications performed by this action. You can use value references in property values (e.g. %username%, %department%). Value references will be replaced with corresponding property values of the directory object on which the action is executed.

Requirements

Minimum required version: 2025.1

See also

© Softerra 2022. All rights reserved.
Send feedback