Share via

Computer Management Provider::Set Properties

  • Article

The Set Properties method allows you to set a property or collection of properties on a WinNT object.

Arguments

Input argument Required Description

Path

Yes

The full WinNT:// path of the object to update.

For valid WinNT path specifications, see Definition of Terms for the Computer Management Provider API [HMC SDK].

Properties

Yes

The collection of properties to set.

Property

Yes

A node representing the property to set.

  • @name - Display name for the property.

  • [@mode] - Control code that indicates how the procedure handles the incoming property value. If values for the property are provided, the default mode is update. If no values are provided for the property the default mode is "clear". The mode attribute corresponds to ADS_PROPERTY_OPERATION_ENUM for IADs::PutEx.

    • "clear" - Resets the property value to "no-value".

    • "update" - Replaces existing values with new ones.

    • "append" - Adds new values to existing ones.

    • "delete" - Removes specified values.

[value]

No

A node containing the value with which to update the property indicated by property/@name. The new value may also be provided as the inner text of the property node. In the case of a multivalued property with which you want to set multiple values, you must use the value nodes and should include one value node for each value you wish to assign.

[username]

No

The username to be used when connecting to the server. This parameter is the "key" parameter for using declarative authentication, meaning that if this value is present, the password and domain are then required. If this value is not present, values for the other two nodes will be ignored.

[password]

No

The password of the user connecting to the server. If username is provided, this value is required; otherwise it is ignored.

[domain]

No

The domain to use in conjunction with the username above. If username is provided, this value is required; otherwise it is ignored.

Note

Prior to updating the object, the provider will validate that any properties selected to be set are valid for the given object type. If inconsistencies are found, an exception will be thrown.

Remarks

Rollback

For the Set Properties method, rollback consists of calling the Set Properties method to restore the original property settings. Prior to updating the object, the provider gets the current value(s) of any properties selected to be updated and stores them so they can be properly restored if rollback is required.

Sample Code

Example XML Request

The following is an example of an XML request for the Set Properties method of the Computer Management Provider:

<request> 
        <procedure> 
                <execute namespace="Computer Management Provider" procedure="Set Properties"> 
                        <executeData> 
                        <path>WinNT://Fabrikam/Web01/SampleUser</path> 
                        <properties> 
                                <property name="Description">This is an updated sample  
                                 description</property> 
                                <property name="FullName"> 
                                        <value>User, Sample</value> 
                                </property> 
                        </properties> 
                        </executeData> 
                </execute> 
        </procedure> 
</request>

Example XML Response

No example XML response.

Applies To

Computer Management Provider API for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

Computer Management Provider::Get Properties