Modify Method

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

Syntax

ANSI (Cross Platform)
int Modify();

Unicode (Windows)
INT Modify();
- (void)modify;
#define MID_LDAP_MODIFY 17

IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_LDAP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 C++ Edition - Version 20.0 [Build 8307]