Sets one or more properties for an object. Used by Microsoft® Provisioning Framework (MPF).
Set Properties is a wrapper for IADs::PutEx.
The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.
<executeData>1..1 <path>1..1 <properties>1..1 <property name=".." mode="..">1..unbounded <value></value>0..unbounded </property> </properties> <flagSkipAction>0..1</flagSkipAction> </executeData>
Set Properties does not return data.
The following table describes the XML schema elements and attributes. Unless otherwise indicated, the data type is string.
|Element||Description, relationships, and attributes|
Encapsulates the procedure's input data.
Prevents the procedure from executing. If this element is specified, the procedure does not update object properties, even during rollback.
Now that MPF supports try/catch error handling (through try and catch elements), there is little need to specify flagSkipAction. This node was originally introduced to support error handling for Create Object. For example, a Create Object call ordinarily fails if the user already exists. To override this behavior, the request can include a flagIgnoreAlreadyExistsError node, which instructs Create Object to return a flagSkipAction node. Subsequent calls pass this node to prevent further operations on the object. In the case of Set Properties, the presence of flagSkipAction prevents accidental changes to object properties.
Lightweight directory access protocol (LDAP) path of the object to set properties for.
List of Microsoft® Active Directory® properties to set. If there is no properties node or the element is empty, E_INVALIDARG is returned.
Individual Active Directory property.
Value for the Active Directory property. Properties with multiple values have corresponding value nodes. A property with a single value can pass it as a text node for the property element instead of as a separate value node. Some data types, such as boolean, dateTime and bin.hex must be explicitly typed using an XML data type. This data type must reside in the immediate parent of the text node. For example:
When Set Properties is executed during rollback, it restores the original values.