This topic has not yet been rated - Rate this topic

LdapException Class

.NET Framework 4.5

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

System.Object
  System.Exception
    System.DirectoryServices.Protocols.DirectoryException
      System.DirectoryServices.Protocols.LdapException

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

Syntax

C++

[SerializableAttribute]
public class LdapException : DirectoryException, 
	ISerializable

The LdapException type exposes the following members.

Constructors

	Name	Description
	LdapException()	The LdapException() constructor creates an instance of the LdapException class.
	LdapException(Int32)	The LdapException(Int32) constructor creates an instance of the LdapException class using the specified error code. The default message displayed to the client is "Communications error with the LDAP server".
	LdapException(String)	The LdapException(String) constructor creates an instance of the LdapException class using the specified message.
	LdapException(Int32, String)	The LdapException(Int32, String) constructor creates an instance of the LdapException class using the specified error code and message.
	LdapException(SerializationInfo, StreamingContext)	The LdapException(SerializationInfo, StreamingContext) constructor creates an instance of the LdapException class using the specified serialization data and streaming context.
	LdapException(String, Exception)	The LdapException(String, Exception) constructor creates an instance of the LdapException class using the specified message and inner exception.
	LdapException(Int32, String, Exception)	The LdapException(Int32, String, Exception) constructor creates an instance of the LdapException class using the specified error code, message, and inner exception.
	LdapException(Int32, String, String)	The LdapException(Int32, String, String) constructor creates an instance of the LdapException class using the specified error code, message, and LDAP server error message.

Top

Properties

	Name	Description
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
	ErrorCode	The ErrorCode property contains the LDAP error code.
	HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
	HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
	InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception.)
	Message	Gets a message that describes the current exception. (Inherited from Exception.)
	PartialResults	The PartialResults property contains a PartialResultsCollection object that contains partial results.
	ServerErrorMessage	The ServerErrorMessage property contains a String that contains the LDAP server error message (if any exists).
	Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
	StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
	TargetSite	Gets the method that throws the current exception. (Inherited from Exception.)

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetBaseException	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetObjectData	The GetObjectData method populates the SerializationInfo object with the data required to serialize the parameter. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)
	GetType	Gets the runtime type of the current instance. (Inherited from Exception.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Creates and returns a string representation of the current exception. (Inherited from Exception.)

Top

Events

	Name	Description
	SerializeObjectState	Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)

Top

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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.

Reference

System.DirectoryServices.Protocols Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)