This documentation is archived and is not being maintained.

LdapSessionOptions Class

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


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

public class LdapSessionOptions

The LdapSessionOptions type exposes the following members.

Public propertyAutoReconnectThe AutoReconnect property specifies if auto-reconnect is enabled.
Public propertyDomainNameThe DomainName property returns the domain to which this connection is bound.
Public propertyHostNameThe HostName property returns the name of the LDAP server associated with the connection.
Public propertyHostReachableThe HostReachable property specifies whether the host is reachable.
Public propertyLocatorFlagThe LocatorFlag property specifies one of the values of the LocatorFlags enumeration that are used when locating a domain controller.
Public propertyPingKeepAliveTimeoutThe PingKeepAliveTimeout property contains a TimeSpan object that specifies the minimum number of seconds the client waits, after the last response from the server, before sending a keep-alive ping.
Public propertyPingLimitThe PingLimit property contains the number of unanswered pings that the client sends before closing a connection.
Public propertyPingWaitTimeoutThe PingWaitTimeout property contains a TimeSpan object that specifies the number of milliseconds that the client waits for the response to come back after sending a ping.
Public propertyProtocolVersionThe ProtocolVersion property specifies the LDAP protocol version to use.
Public propertyQueryClientCertificateThe QueryClientCertificate property contains a QueryClientCertificateCallback object that specifies the default callback function used to specify client certificates when establishing an SSL connection.
Public propertyReferralCallbackThe ReferralCallback property contains a ReferralCallback object that specifies the default callback function used when chasing referrals.
Public propertyReferralChasingThe ReferralChasing property contains a ReferralChasingOption object that specifies how the LDAP library follows referrals returned by LDAP servers.
Public propertyReferralHopLimitThe ReferralHopLimit property specifies the number of hops allowed when chasing referrals.
Public propertyRootDseCacheThe RootDseCache property enables the internal RootDSE cache.
Public propertySaslMethodThe SaslMethod property specifies the preferred Simple Authentication and Security Layer (SASL) binding method.
Public propertySealingThe Sealing property enables Kerberos encryption.
Public propertySecureSocketLayerThe SecureSocketLayer property enables secure socket layer on connection.
Public propertySecurityContextThe SecurityContext property specifies the security context associated with the current connection.
Public propertySendTimeoutThe SendTimeout property contains a TimeSpan object that specifies the send time-out.
Public propertySigningThe Signing property enables Kerberos encryption.
Public propertySslInformationThe SslInformation property contains a SecurityPackageContextConnectionInformation object that contains data about the current secure connection.
Public propertySspiFlagThe SspiFlag property specifies the flags to pass to the Security Support Provider Interface (SSPI) InitializeSecurityContext function. For more information about the InitializeSecurityContext function, see the InitializeSecurityContext function topic in the MSDN library at .
Public propertyTcpKeepAliveThe TcpKeepAlive property enables TCP keep-alive.
Public propertyVerifyServerCertificateThe VerifyServerCertificate property contains a VerifyServerCertificateCallback object that specifies the default callback method to use to verify server certificates when an SSL connection is established.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodFastConcurrentBindThe FastConcurrentBind method enables support for fast concurrent binds.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStartTransportLayerSecurityThe StartTransportLayerSecurity method starts transport layer security encryption.
Public methodStopTransportLayerSecurityThe StopTransportLayerSecurity method ends transport layer security encryption.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

.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.