LdapConnection Class

.NET Framework (current version)

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

Namespace: System.DirectoryServices.Protocols
Assembly: System.DirectoryServices.Protocols (in System.DirectoryServices.Protocols.dll)

Inheritance Hierarchy

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

Syntax

C++

public ref class LdapConnection : DirectoryConnection, IDisposable

Constructors

	Name	Description
	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.
	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.
	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.
	LdapConnection(String^)	The LdapConnection(String^) constructor creates an instance of the LdapConnection class using the specified server.

Properties

	Name	Description
	AuthType	The AuthType property contains the supported authentication types.
	AutoBind	The AutoBind property specifies whether an automatic bind is allowed.
	ClientCertificates	The ClientCertificates property specifies one or more client certificates to send for authentication.(Inherited from DirectoryConnection.)
	Credential	The Credential property contains the network credentials for the object.(Overrides DirectoryConnection::Credential.)
	Directory	The Directory property specifies the domain or the server to which the connection should be made.(Inherited from DirectoryConnection.)
	SessionOptions	The SessionOptions property contains an LdapSessionOptions object that specifies the session options.
	Timeout	The Timeout property contains the length of time, in seconds, before the LdapConnection times out.(Overrides DirectoryConnection::Timeout.)

Methods

	Name	Description
	Abort(IAsyncResult^)	The Abort method cancels the asynchronous request.
	BeginSendRequest(DirectoryRequest^, PartialResultProcessing, AsyncCallback^, Object^)	The BeginSendRequest method sends data asynchronously to the server.
	BeginSendRequest(DirectoryRequest^, TimeSpan, PartialResultProcessing, AsyncCallback^, Object^)	The BeginSendRequest method sends data asynchronously to the server.
	Bind()	The Bind() method sends an LDAP bind using the current credentials.
	Bind(NetworkCredential^)	The Bind(NetworkCredential^) method sends an LDAP bind using the specified NetworkCredential.
	Dispose()	The Dispose() method closes and releases the LDAP handle.
	Dispose(Boolean)	The Dispose(Boolean) method closes the connection and optionally releases the LDAP handle.
	EndSendRequest(IAsyncResult^)	The EndSendRequest method completes an asynchronous request.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	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().)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetPartialResults(IAsyncResult^)	The GetPartialResults method retrieves partial results of an asynchronous operation.
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	SendRequest(DirectoryRequest^)	The SendRequest method sends a single DirectoryRequest as an LDAP v3 operation.(Overrides DirectoryConnection::SendRequest(DirectoryRequest^).)
	SendRequest(DirectoryRequest^, TimeSpan)	The SendRequest method sends a single DirectoryRequest as an LDAP v3 operation.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

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.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.