IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

Modify Method

Performs an LDAP 'modify' operation on the entry specified by DN .

Syntax

ldap.modify([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 performs an LDAP 'modify' operation on the entry specified by DN. The attribute(s) to modify should be set via the Attributes properties. When specifying multi-valued attributes, specify the attribute type only in the first occurrence of that attribute type in the Attributes properties. Additional occurrences of the same attribute type should specify an attribute type of empty string.

The modification can be a replacement, an addition, or a deletion, depending on the ModOp field of the attribute;. The result of the operation is returned via the Result event.

Example (Modify an Entry - Replace an Attribute Value)


LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.AttributeCount = 2
LDAPControl.AttributeType(0) = "url"
LDAPControl.AttributeValue(0) = "www.url1.net"
LDAPControl.AttributeModOp(0) = amoReplace
LDAPControl.AttributeType(0) = ""
LDAPControl.AttributeValue(0) = "www.url2.net"
LDAPControl.AttributeModOp(0) = amoReplace
LDAPControl.Modify()

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0