System.DirectoryServices.Protocols Namespace

The System.DirectoryServices.Protocols namespace provides the methods defined in the Lightweight Directory Access Protocol (LDAP) version 3 (V3) and Directory Services Markup Language (DSML) version 2.0 (V2) standards.

Classes

AddRequest

The AddRequest class adds an entry to the directory.

AddResponse

The AddResponse class is returned by SendRequest(DirectoryRequest) as a response to AddRequest.

AsqRequestControl

The AsqRequestControl class creates an attribute scoped query (ASQ) control. This control is used with a search request to force the query to be based on a specific DN-valued attribute.

AsqResponseControl

The AsqResponseControl class is returned in a SearchResponse object as a response to a AsqRequestControl query.

BerConversionException

The BerConversionException class is an exception thrown when converting data using a BerConverter object.

BerConverter

The BerConverter class encodes and decodes structured data using basic encoding rules (BER).

CompareRequest

The CompareRequest class determines whether the directory object holds the specified value for the attribute.

CompareResponse

The CompareResponse class is returned by SendRequest(DirectoryRequest) as a response to CompareRequest.

CrossDomainMoveControl

The CrossDomainMoveControl class is used with a ModifyDNRequest object to move an LDAP object from one domain to another.

DeleteRequest

The DeleteRequest class deletes an entry from the directory.

DeleteResponse

The DeleteResponse class is returned by SendRequest(DirectoryRequest) as a response to DeleteRequest.

DirectoryAttribute

The DirectoryAttribute class enables access to the attribute values.

DirectoryAttributeCollection

The DirectoryAttributeCollection class contains a collection of DirectoryAttribute objects.

DirectoryAttributeModification

The DirectoryAttributeModification class enables modification of the DirectoryAttribute values.

DirectoryAttributeModificationCollection

The DirectoryAttributeModificationCollection class contains a collection of DirectoryAttributeModification objects.

DirectoryConnection

The DirectoryConnection class is an abstract class and cannot be instantiated. Use the LdapConnection or DsmlSoapHttpConnection classes to connect to a directory server.

DirectoryControl

The DirectoryControl class specifies extension data for various LDAP operations.

DirectoryControlCollection

The DirectoryControlCollection class manages a collection of DirectoryControl objects.

DirectoryException

The DirectoryException class is an abstract class used as the base class for all System.DirectoryServices.Protocols exceptions.

DirectoryIdentifier

The DirectoryIdentifier class is an abstract class that identifies the target to connect to.

DirectoryNotificationControl

The DirectoryNotificationControl class is a directory control used with an extended LDAP asynchronous search function to register the client to be notified when changes are made to an object in the Active Directory Domain Services.

DirectoryOperation

The DirectoryOperation class is an abstract class used as a base for request and response elements.

DirectoryOperationException

The DirectoryOperationException class is an exception thrown by the SendRequest(DirectoryRequest) method to indicate that the server returned a DirectoryResponse object with an error.

DirectoryRequest

The DirectoryRequest class is the base class for request related classes, like the SearchRequest and AddRequest classes.

DirectoryResponse

The DirectoryResponse class is the base class for request response classes, like the SearchResponse and AddResponse classes.

DirSyncRequestControl

The DirSyncRequestControl class is a directory control that enables the application to search the directory for objects that have changed since a previous state.

DirSyncResponseControl

The DirSyncResponseControl class is a directory control used to pass DirSyncRequest information from the server to the client.

DomainScopeControl

The DomainScopeControl class is a directory control used to instruct the LDAP server not to generate referrals when completing a request.

DsmlAuthRequest

The DsmlAuthRequest class indicates that access control for the requests be interpreted as though the requests are performed by the security principal identified by the Principal property.

DsmlAuthResponse

The DsmlAuthResponse class is returned by SendRequest(DirectoryRequest) as a response to DsmlAuthRequest.

DsmlDirectoryIdentifier

The DsmlDirectoryIdentifier class identifies an HTTP server.

DsmlDocument

The DsmlDocument class is an abstract class to construct or manipulate a DSML document. It is the base class for both DsmlRequestDocument and DsmlResponseDocument. DsmlDocument supports collections and indexes. Each item in its collection is an object derived from DirectoryOperation.

DsmlErrorResponse

The DsmlErrorResponse class is generated by the server when a severe error occurs.

DsmlInvalidDocumentException

The DsmlInvalidDocumentException class is an exception that occurs when a DSML Request or Response document is not well-formed XML or cannot be validated with DSMLv2 schema.

DsmlRequestDocument

The DsmlRequestDocument class enables you to build a DSML request payload, such as AddRequest, ModifyRequest, or SearchRequest. It contains zero or more DirectoryRequest derived objects. The user may add, delete, modify, and enumerate the DirectoryRequest before sending to the server. DsmlRequestDocument can be used with any DSML Binding classes to transport the document, such as DsmlSoapHttpConnection.

DsmlResponseDocument

The DsmlResponseDocument class is a read-only collection generated as a response to a DsmlRequestDocument object that contains zero, or more, objects derived from DirectoryResponse.

DsmlSoapConnection

The DsmlSoapConnection class is an abstract class that cannot be instantiated. It enables stateless and stateful protocols to be handled similarly by providing session-oriented features.

DsmlSoapHttpConnection

The DsmlSoapHttpConnection class represents a connection to a DSML Gateway using SOAP over HTTP.

ErrorResponseException

The ErrorResponseException class is an exception that occurs when the server returns an <errorResponse>.

ExtendedDNControl

The ExtendedDNControl class requests an extended form of the distinguished name of an Active Directory Domain Services object.

ExtendedRequest

The ExtendedRequest class passes extended LDAP operations to the server.

ExtendedResponse

The ExtendedResponse class is returned by SendRequest(DirectoryRequest) as a response to ExtendedRequest.

LazyCommitControl

The LazyCommitControl class instructs the server to return the results of a DS modification command, such as add, delete, or replace, after it has been completed in memory, but before it has been committed to disk.

LdapConnection

The LdapConnection class creates a TCP/IP or UDP LDAP connection to Microsoft Active Directory Domain Services or an LDAP server.

LdapDirectoryIdentifier

The LdapDirectoryIdentifier class creates a directory identifier for one or more LDAP servers.

LdapException

The LdapException class is an exception that occurs when LDAP returns an error code not included in ResultCode.

LdapSessionOptions

The LdapSessionOptions class is used to get or set various LDAP session options.

ModifyDNRequest

The ModifyDNRequest class modifies the distinguished name of an object. This class moves an object to a new parent and/or renames the object.

ModifyDNResponse

The ModifyDNResponse class is returned by SendRequest(DirectoryRequest) as a response to ModifyDNRequest.

ModifyRequest

The ModifyRequest class modifies the attributes of an existing directory entry.

ModifyResponse

The ModifyResponse class is returned by SendRequest(DirectoryRequest) as a response to ModifyRequest.

PageResultRequestControl

The PageResultRequestControl class instructs the server to return the search result in the specified page size.

PageResultResponseControl

The PageResultResponseControl class is a directory control used to pass page data from the server to the client.

PartialResultsCollection

The PartialResultsCollection class represents any partial results returned from a not-yet-completed asynchronous operation.

PermissiveModifyControl

The PermissiveModifyControl class is used to modify the behavior of a ModifyRequest object.

QuotaControl

The QuotaControl class is used to pass the security identifier (SID) of a security principle to retrieve quota-related data.

ReferralCallback

The ReferralCallback class contains delegates used as referral callback methods.

SearchOptionsControl

The SearchOptionsControl class is used to pass flags to the server to control search behavior.

SearchRequest

The SearchRequest class initiates a search operation.

SearchResponse

The SearchResponse class is sent by the server as a response to a SearchRequest object. This response contains zero or more SearchResultEntry objects, and zero or more SearchResultReference objects.

SearchResultAttributeCollection

The SearchResultAttributeCollection class is a collection of DirectoryAttribute objects.

SearchResultEntry

The SearchResultEntry class contains an object returned in the result set.

SearchResultEntryCollection

The SearchResultEntryCollection class contains a collection of SearchResultEntry objects returned in a result set.

SearchResultReference

The SearchResultReference class contains a single search reference returned by the server.

SearchResultReferenceCollection

The SearchResultReferenceCollection class contains a collection of SearchResultReference objects.

SecurityDescriptorFlagControl

The SecurityDescriptorFlagControl class is used to pass flags to the server to control various security descriptor behaviors.

SecurityPackageContextConnectionInformation

The SecurityPackageContextConnectionInformation class contains data about a secure connection.

ShowDeletedControl

The ShowDeletedControl class is used with SearchRequest to specify that the search results should include any deleted objects that match the search filter.

SortKey

The SortKey class stores sort criteria for use by sort controls.

SortRequestControl

The SortRequestControl class is used with SearchRequest to instruct the server to sort the search results before returning them to the client application.

SortResponseControl

The SortResponseControl class is used to pass sort data from the server to the client.

TlsOperationException

The TlsOperationException class is an exception that occurs in the StartTransportLayerSecurity(DirectoryControlCollection) method if the request fails.

TreeDeleteControl

The TreeDeleteControl class is used with DeleteRequest to delete an entire subtree in the directory.

VerifyNameControl

The VerifyNameControl class is used with an LDAP search function to specify the server used to verify the existence of an object.

VlvRequestControl

The VlvRequestControl class is used to request virtual list view (VLV) support from the server.

VlvResponseControl

The VlvResponseControl class is used to pass virtual list view (VLV) data from the server to the client.

Enums

AuthType

The AuthType enumeration is used to specify the authentication method to use on a connection.

DereferenceAlias

The DereferenceAlias enumeration specifies the process by which aliases are dereferenced.

DirectoryAttributeOperation

The DirectoryAttributeOperation enumeration specifies the operation to perform on a directory attribute.

DirectorySynchronizationOptions

The DirectorySynchronizationOptions enumeration specifies the behavior of the search in a DirSyncRequestControl object.

DsmlDocumentProcessing

The DsmlDocumentProcessing enumeration specifies the processing method for a DSML document.

DsmlErrorProcessing

The DsmlErrorProcessing enumeration specifies how to proceed when an error occurs.

DsmlResponseOrder

The DsmlResponseOrder enumeration specifies the order in which responses are received.

ErrorResponseCategory

The ErrorResponseCategory enumeration contains possible DSML error responses.

ExtendedDNFlag

The ExtendedDNFlag enumeration specifies the format of an extended distinguished name.

LocatorFlags

The LocatorFlags enumeration specifies data required to locate a domain controller.

PartialResultProcessing

The PartialResultProcessing enumeration specifies the required type of partial results processing.

ReferralChasingOptions

The ReferralChasingOptions enumeration specifies if and how referral chasing is pursued.

ResultCode

The ResultCode enumeration specifies the operation result codes.

SearchOption

The SearchOption enumeration specifies the search options which define how the search will behave.

SearchScope

The SearchScope enumeration specifies the scope of a search.

SecurityMasks

The SecurityMasks enumeration specifies various security descriptor options.

SecurityProtocol

The SecurityProtocol enumeration is used to specify the security protocol used by a connection.

Delegates

DereferenceConnectionCallback

The DereferenceConnectionCallback delegate dereferences a connection that is no longer required. The connection was probably established through a successful call to the QueryForConnectionCallback or NotifyOfNewConnectionCallback delegate.

NotifyOfNewConnectionCallback

The NotifyOfNewConnectionCallback delegate is called if a new connection was created while chasing a referral.

QueryClientCertificateCallback

The QueryClientCertificateCallback delegate gets or sets the default callback function used to specify the client certificates while establishing an SSL connection.

QueryForConnectionCallback

The QueryForConnectionCallback delegate determines whether there is a cached connection available for use.

VerifyServerCertificateCallback

The VerifyServerCertificateCallback delegate gets or sets the default callback function used to verify server certificates when establishing an SSL connection.