LDAPRenameAttribute (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Rename
Modifying an existing object on an LDAP server

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

LDAP functions

LDAPRenameAttribute (Function)

In french: LDAPRenommeAttribut

Renames an attribute. The value of attributes is stored during this operation.

Example

// "AttributeName" is renamed to "Name2"
LDAPStartModify("SessionName")
LDAPRenameAttribute("SessionName", "AttributeName", "Name2")
LDAPValidateModify("SessionName", "DN")

Syntax

<Result> = LDAPRenameAttribute(<LDAP session> , <Former Attribute Name> , <New Attribute Name>)

<Result>: Boolean

True if the modification was performed,
False otherwise. ErrorInfo returns more details about the error.
The modification will be performed during the call to LDAPValidateModify.

<LDAP session>: Character string (with quotes)

Name of LDAP session used.

<Former Attribute Name>: Character string (with quotes)

Current name of attribute to use.

<New Attribute Name>: Character string (with quotes)

New name of attribute to use.

Remarks

Rename

The new name of the attribute must be a valid attribute for the modified object.

If the rename operation concerns a multi-valued attribute, the new name must correspond to a valid and multi-valued attribute. Otherwise, an error will occur when using LDAPValidateModify.

Modifying an existing object on an LDAP server

To modify an existing object in an LDAP server, you must define the different modifications to perform.

To optimize the modification speed of objects, the modifications are defined locally: a single communication is established with the server when validating the modification. The steps are:

Initialize the modification (LDAPStartModify).
Modification operations:
- Add the attributes and their values (LDAPAddAttribute).
- Delete the attributes (LDAPDeleteAttribute) or their values (LDAPDeleteAttributeValue).
- Replace the values of an attribute (LDAPReplaceAttribute or LDAPReplaceAttributeValue).
- Renaming the attribute (LDAPRenameAttribute)
Validate the modifications on the server (LDAPValidateModify). The modifications are performed on the server according to the order used in the WLanguage code.

Component : wd250com.dll