Class LdapModification
A single add, delete, or replace operation to an LdapAttribute.
An LdapModification contains information on the type of modification
being performed, the name of the attribute to be replaced, and the new
value. Multiple modifications are expressed as an array of modifications,
i.e., LdapModification[].
An LdapModification or an LdapModification array enable you to modify
an attribute of an Ldap entry. The entire array of modifications must
be performed by the server as a single atomic operation in the order they
are listed. No changes are made to the directory unless all the operations
succeed. If all succeed, a success result is returned to the application.
It should be noted that if the connection fails during a modification,
it is indeterminate whether the modification occurred or not.
There are three types of modification operations: Add, Delete,
and Replace.
Add: Creates the attribute if it doesn't exist, and adds
the specified values. This operation must contain at least one value, and
all values of the attribute must be unique.
Delete: Deletes specified values from the attribute. If no
values are specified, or if all existing values of the attribute are
specified, the attribute is removed. Mandatory attributes cannot be
removed.
Replace: Creates the attribute if necessary, and replaces
all existing values of the attribute with the specified values.
If you wish to keep any existing values of a multi-valued attribute,
you must include these values in the replace operation.
A replace operation with no value will remove the entire attribute if it
exists, and is ignored if the attribute does not exist.
Additional information on Ldap modifications is available in section 4.6
of. rfc2251.txt
Inherited Members
Namespace: Swan.Ldap
Syntax
public sealed class LdapModification : LdapMessageConstructors
LdapModification(LdapModificationOp, LdapAttribute)
Initializes a new instance of the LdapModification class. Specifies a modification to be made to an attribute.
Declaration
public LdapModification(LdapModificationOp op, LdapAttribute attr)Parameters
| Type | Name | Description |
|---|---|---|
| LdapModificationOp | op | The op. |
| LdapAttribute | attr | The attribute to modify. |
LdapModification(LdapModificationOp, String, String)
Initializes a new instance of the LdapModification class.
Declaration
public LdapModification(LdapModificationOp op, string attrName, string attrValue)Parameters
| Type | Name | Description |
|---|---|---|
| LdapModificationOp | op | The op. |
| String | attrName | Name of the attribute. |
| String | attrValue | The attribute value. |
Properties
Attribute
Returns the attribute to modify, with any existing values.
Declaration
public LdapAttribute Attribute { get; }Property Value
| Type | Description |
|---|---|
| LdapAttribute | The attribute. |
Op
Returns the type of modification specified by this object.
Declaration
public LdapModificationOp Op { get; }Property Value
| Type | Description |
|---|---|
| LdapModificationOp | The op. |
