System.DirectoryServices.Protocols
TOC
Collapse the table of content
Expand the table of content

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.

ClassDescription
System_CAPS_pubclassAddRequest

The AddRequest class adds an entry to the directory.

System_CAPS_pubclassAddResponse

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

System_CAPS_pubclassAsqRequestControl

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.

System_CAPS_pubclassAsqResponseControl

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

System_CAPS_pubclassBerConversionException

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

System_CAPS_pubclassBerConverter

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

System_CAPS_pubclassCompareRequest

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

System_CAPS_pubclassCompareResponse

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

System_CAPS_pubclassCrossDomainMoveControl

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

System_CAPS_pubclassDeleteRequest

The DeleteRequest class deletes an entry from the directory.

System_CAPS_pubclassDeleteResponse

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

System_CAPS_pubclassDirectoryAttribute

The DirectoryAttribute class enables access to the attribute values.

System_CAPS_pubclassDirectoryAttributeCollection

The DirectoryAttributeCollection class contains a collection of DirectoryAttribute objects.

System_CAPS_pubclassDirectoryAttributeModification

The DirectoryAttributeModification class enables modification of the DirectoryAttribute values.

System_CAPS_pubclassDirectoryAttributeModificationCollection
System_CAPS_pubclassDirectoryConnection

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

System_CAPS_pubclassDirectoryControl

The DirectoryControl class specifies extension data for various LDAP operations.

System_CAPS_pubclassDirectoryControlCollection

The DirectoryControlCollection class manages a collection of DirectoryControl objects.

System_CAPS_pubclassDirectoryException

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

System_CAPS_pubclassDirectoryIdentifier

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

System_CAPS_pubclassDirectoryNotificationControl

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.

System_CAPS_pubclassDirectoryOperation

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

System_CAPS_pubclassDirectoryOperationException

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

System_CAPS_pubclassDirectoryRequest

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

System_CAPS_pubclassDirectoryResponse

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

System_CAPS_pubclassDirSyncRequestControl

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

System_CAPS_pubclassDirSyncResponseControl

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

System_CAPS_pubclassDomainScopeControl

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

System_CAPS_pubclassDsmlAuthRequest

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.

System_CAPS_pubclassDsmlAuthResponse

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

System_CAPS_pubclassDsmlDirectoryIdentifier

The DsmlDirectoryIdentifier class identifies an HTTP server.

System_CAPS_pubclassDsmlDocument

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.

System_CAPS_pubclassDsmlErrorResponse

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

System_CAPS_pubclassDsmlInvalidDocumentException

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.

System_CAPS_pubclassDsmlRequestDocument

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.

System_CAPS_pubclassDsmlResponseDocument

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.

System_CAPS_pubclassDsmlSoapConnection

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.

System_CAPS_pubclassDsmlSoapHttpConnection

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

System_CAPS_pubclassErrorResponseException

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

System_CAPS_pubclassExtendedDNControl

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

System_CAPS_pubclassExtendedRequest

The ExtendedRequest class passes extended LDAP operations to the server.

System_CAPS_pubclassExtendedResponse

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

System_CAPS_pubclassLazyCommitControl

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.

System_CAPS_pubclassLdapConnection

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

System_CAPS_pubclassLdapDirectoryIdentifier

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

System_CAPS_pubclassLdapException

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

System_CAPS_pubclassLdapSessionOptions

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

System_CAPS_pubclassModifyDNRequest

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

System_CAPS_pubclassModifyDNResponse

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

System_CAPS_pubclassModifyRequest

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

System_CAPS_pubclassModifyResponse

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

System_CAPS_pubclassPageResultRequestControl

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

System_CAPS_pubclassPageResultResponseControl

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

System_CAPS_pubclassPartialResultsCollection

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

System_CAPS_pubclassPermissiveModifyControl

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

System_CAPS_pubclassQuotaControl

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

System_CAPS_pubclassReferralCallback

The ReferralCallback class contains delegates used as referral callback methods.

System_CAPS_pubclassSearchOptionsControl

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

System_CAPS_pubclassSearchRequest

The SearchRequest class initiates a search operation.

System_CAPS_pubclassSearchResponse

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.

System_CAPS_pubclassSearchResultAttributeCollection

The SearchResultAttributeCollection class is a collection of DirectoryAttribute objects.

System_CAPS_pubclassSearchResultEntry

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

System_CAPS_pubclassSearchResultEntryCollection

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

System_CAPS_pubclassSearchResultReference

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

System_CAPS_pubclassSearchResultReferenceCollection

The SearchResultReferenceCollection class contains a collection of SearchResultReference objects.

System_CAPS_pubclassSecurityDescriptorFlagControl

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

System_CAPS_pubclassSecurityPackageContextConnectionInformation

The SecurityPackageContextConnectionInformation class contains data about a secure connection.

System_CAPS_pubclassShowDeletedControl

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

System_CAPS_pubclassSortKey

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

System_CAPS_pubclassSortRequestControl

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

System_CAPS_pubclassSortResponseControl

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

System_CAPS_pubclassTlsOperationException

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

System_CAPS_pubclassTreeDeleteControl

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

System_CAPS_pubclassVerifyNameControl

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

System_CAPS_pubclassVlvRequestControl

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

System_CAPS_pubclassVlvResponseControl

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

DelegateDescription
System_CAPS_pubdelegateDereferenceConnectionCallback

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.

System_CAPS_pubdelegateNotifyOfNewConnectionCallback

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

System_CAPS_pubdelegateQueryClientCertificateCallback

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

System_CAPS_pubdelegateQueryForConnectionCallback

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

System_CAPS_pubdelegateVerifyServerCertificateCallback

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

EnumerationDescription
System_CAPS_pubenumAuthType

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

System_CAPS_pubenumDereferenceAlias

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

System_CAPS_pubenumDirectoryAttributeOperation

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

System_CAPS_pubenumDirectorySynchronizationOptions

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

System_CAPS_pubenumDsmlDocumentProcessing

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

System_CAPS_pubenumDsmlErrorProcessing

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

System_CAPS_pubenumDsmlResponseOrder

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

System_CAPS_pubenumErrorResponseCategory

The ErrorResponseCategory enumeration contains possible DSML error responses.

System_CAPS_pubenumExtendedDNFlag

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

System_CAPS_pubenumLocatorFlags

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

System_CAPS_pubenumPartialResultProcessing

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

System_CAPS_pubenumReferralChasingOptions

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

System_CAPS_pubenumResultCode

The ResultCode enumeration specifies the operation result codes.

System_CAPS_pubenumSearchOption

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

System_CAPS_pubenumSearchScope

The SearchScope enumeration specifies the scope of a search.

System_CAPS_pubenumSecurityMasks

The SecurityMasks enumeration specifies various security descriptor options.

System_CAPS_pubenumSecurityProtocol

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

Return to top
Show:
© 2016 Microsoft