SetProperty Method

Set the value of a property.

Syntax

webdav.setProperty(propertyName, propertyValue, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method is used to set a single property to a certain value. The name and new value of the property must be supplied in the parameters for this method.

NOTE: This is the same as calling the PatchProperties on one property where the operation is opSet.

Example


Control.SetProperty("MyProperty", "MyValue")

is equivalent to:

Control.PropertyCount = 1
Control.PropertyName(0) = "MyProperty"
Control.PropertyValue(0) = "MyValue"
Control.PropertyOperation(0) = opSet
Control.PatchProperties()

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8161]