0 out of 2 rated this helpful - Rate this topic

LdapConnection Class

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

System.Object
  System.DirectoryServices.Protocols.DirectoryConnection
    System.DirectoryServices.Protocols.LdapConnection

Namespace:  System.DirectoryServices.Protocols
Assembly:  System.DirectoryServices.Protocols (in System.DirectoryServices.Protocols.dll)
public class LdapConnection : DirectoryConnection, 
	IDisposable

The LdapConnection type exposes the following members.

  Name Description
Public method LdapConnection(LdapDirectoryIdentifier) The LdapConnection(LdapDirectoryIdentifier) constructor creates an instance of the LdapConnection class using the specified directory identifier. The logon credentials and the Negotiate Authentication are used to connect to the LDAP server.
Public method LdapConnection(String) The LdapConnection(String) constructor creates an instance of the LdapConnection class using the specified server.
Public method LdapConnection(LdapDirectoryIdentifier, NetworkCredential) The LdapConnection(LdapDirectoryIdentifier, NetworkCredential) constructor creates an instance of the LdapConnection class using the specified directory identifier and network credentials. Negotiate Authentication is used.
Public method LdapConnection(LdapDirectoryIdentifier, NetworkCredential, AuthType) The LdapConnection(LdapDirectoryIdentifier, NetworkCredential, AuthType) constructor creates an instance of the LdapConnection class using the specified directory identifier, network credentials, and authentication type.
Top
  Name Description
Public property AuthType The AuthType property contains the supported authentication types.
Public property AutoBind The AutoBind property specifies whether an automatic bind is allowed.
Public property ClientCertificates The ClientCertificates property specifies one or more client certificates to send for authentication. (Inherited from DirectoryConnection.)
Public property Credential The Credential property contains the network credentials for the object. (Overrides DirectoryConnection.Credential.)
Public property Directory The Directory property specifies the domain or the server to which the connection should be made. (Inherited from DirectoryConnection.)
Public property SessionOptions The SessionOptions property contains an LdapSessionOptions object that specifies the session options.
Public property Timeout The Timeout property contains the length of time, in seconds, before the LdapConnection times out. (Overrides DirectoryConnection.Timeout.)
Top
  Name Description
Public method Abort The Abort method cancels the asynchronous request.
Public method BeginSendRequest(DirectoryRequest, PartialResultProcessing, AsyncCallback, Object) The BeginSendRequest method sends data asynchronously to the server.
Public method BeginSendRequest(DirectoryRequest, TimeSpan, PartialResultProcessing, AsyncCallback, Object) The BeginSendRequest method sends data asynchronously to the server.
Public method Bind() The Bind() method sends an LDAP bind using the current credentials.
Public method Bind(NetworkCredential) The Bind(NetworkCredential) method sends an LDAP bind using the specified NetworkCredential.
Public method Dispose() The Dispose() method closes and releases the LDAP handle.
Protected method Dispose(Boolean) The Dispose(Boolean) method closes the connection and optionally releases the LDAP handle.
Public method EndSendRequest The EndSendRequest method completes an asynchronous request.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize The LdapConnection.Finalize method allows an LdapConnection object to attempt to free resources and perform other cleanup operations before the LdapConnection object is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetPartialResults The GetPartialResults method retrieves partial results of an asynchronous operation.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SendRequest(DirectoryRequest) The SendRequest method sends a single DirectoryRequest as an LDAP v3 operation. (Overrides DirectoryConnection.SendRequest(DirectoryRequest).)
Public method SendRequest(DirectoryRequest, TimeSpan) The SendRequest method sends a single DirectoryRequest as an LDAP v3 operation.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

If the ClientCertificates property on the LdapConnection object and QueryClientCertificate property on the LdapSessionOptions object are both set, the certificate specified in the ClientCertificates property is ignored.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ