LDAP Component

Properties   Methods   Events   Config Settings   Errors  

The Lightweight Directory Access Protocol (LDAP) Component is used to search, manage, and maintain internet directory servers.

Syntax

nsoftware.IPWorksAuth.LDAP

Remarks

The LDAP Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The LDAP Component implements a standard LDAP client as specified in RFC 1777, 2251, and other LDAP RFCs. Support for both LDAP v2 and v3 is provided.

The first step in using the component is specifying the ServerName, a DN (distinguished name) to bind as, and optionally a Password. Then you can call one or more of the component methods to act upon the server. Server responses normally are received through the Result event. The only exceptions are search requests that result in one or more SearchResult events, followed by a final SearchComplete event.

Attributes are set and returned through the Attributes collection. Other command arguments are specified through other properties. These are specified in detail in each method.

Search filters are to be specified as string arguments to the Search method. The format must be a standard LDAP search string as specified in RFC 1558. Other search attributes are set in properties, such as SearchScope, SearchTimeLimit, SearchSizeLimit, SearchReturnValues, and SearchDerefAliases.

The component operates synchronously by default (waits for a response before returning control to the caller); however, the component also may operate asynchronously (return control immediately), by setting Timeout to 0. Please refer to the Timeout property for more information.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AcceptData Property (LDAP Component)

This property indicates whether data reception is currently enabled.

Syntax

• C#
• VB.NET

public bool AcceptData { get; }

Public ReadOnly Property AcceptData As Boolean

Default Value

True

Remarks

This property indicates whether data reception is currently enabled. When false, data reception is disabled. Use the PauseData and ProcessData methods to pause and resume data reception.

This property is read-only and not available at design time.

Attributes Property (LDAP Component)

This property includes the attributes for the current entry.

Syntax

• C#
• VB.NET

public LDAPAttributeList Attributes { get; }

Public Property Attributes As LDAPAttributeList

Remarks

This property contains a collection of all of the attributes for the current entry. Each attribute's details are found in the fields of the LDAPAttribute type.

After a Search, this property will be populated with the attributes of each search result and can be read within the SearchResult event (one event for each resulting DN).

During a Lightweight Directory Access Protocol (LDAP) Modify operation, this property describes the modifications that are to be made to the attributes. You may specify the attribute, the new value, and the operation to be executed by the server in this property.

This collection is indexed from 0 to count -1.

This property is not available at design time.

AuthMechanism Property (LDAP Component)

This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server.

Syntax

• C#
• VB.NET

public LDAPAuthMechanisms AuthMechanism { get; set; }

enum LDAPAuthMechanisms {
  lamSimple,
  lamDigestMD5,
  lamNegotiate,
  lamKerberos,
  lamSASLExternal
}

Public Property AuthMechanism As LdapAuthMechanisms

Enum LDAPAuthMechanisms
  lamSimple
  lamDigestMD5
  lamNegotiate
  lamKerberos
  lamSASLExternal
End Enum

Default Value

0

Remarks

This property specifies the authentication mechanism used. Possible values are as follows:

Connected Property (LDAP Component)

This property shows whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; }

Public ReadOnly Property Connected As Boolean

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host. Use the Bind and Unbind methods to manage the connection.

This property is read-only and not available at design time.

DeleteOldRDN Property (LDAP Component)

This property controls whether the old RDN (Relative Distinguished Name) should be deleted.

Syntax

• C#
• VB.NET

public bool DeleteOldRDN { get; set; }

Public Property DeleteOldRDN As Boolean

Default Value

True

Remarks

This property controls whether the old RDN should be deleted. It is used when ModifyRDN is called. The default value is True, which instructs the server to delete the old RDN.

This property is not available at design time.

DN Property (LDAP Component)

This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations.

Syntax

• C#
• VB.NET

public string DN { get; set; }

Public Property DN As String

Default Value

""

Remarks

This also includes the base object during LDAP searches.

The distinguished name is provided in string format, as specified by RFC 1779. Example. Setting DN:

LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.DN = "Domain\Username"

Firewall Property (LDAP Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Idle Property (LDAP Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

LDAPVersion Property (LDAP Component)

The version of the Lightweight Directory Access Protocol (LDAP) used.

Syntax

• C#
• VB.NET

public int LDAPVersion { get; set; }

Public Property LDAPVersion As Integer

Default Value

3

Remarks

This property contains the version of LDAP used. The default value is 3 (for LDAPv3).

This property is not available at design time.

LocalHost Property (LDAP Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

MessageId Property (LDAP Component)

This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request.

Syntax

• C#
• VB.NET

public int MessageId { get; set; }

Public Property MessageId As Integer

Default Value

1

Remarks

This property contains the message identifier for the next LDAP request. If a custom value is needed, this property must be set before calling any other methods. The component increments this property automatically after each request.

This property is not available at design time.

PageSize Property (LDAP Component)

This property includes the maximum number of results per page for the Search method.

Syntax

• C#
• VB.NET

public int PageSize { get; set; }

Public Property PageSize As Integer

Default Value

0

Remarks

This property contains the maximum number of results per page for the Search method. The default value is 0 (no paging). If set to a value greater than zero, results will be paged, that is, returned in blocks of maximum PageSize results.

For each page sent by the server, a SearchPage event will fire. You may decide to cancel or continue displaying results from within this event.

Note: Lightweight Directory Access Protocol (LDAP) paging functionality is described by LDAP extension RFCs and may or may not be implemented by the LDAP server being accessed.

Password Property (LDAP Component)

This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

This property contains the password used to authenticate to the LDAP server. Leave this value empty if no password is required.

This property is not available at design time.

References Property (LDAP Component)

This property includes a collection of references returned from the server.

Syntax

• C#
• VB.NET

public LDAPReferenceList References { get; }

Public ReadOnly Property References As LDAPReferenceList

Remarks

This property contains a collection of references returned from the server. References will be SearchResult references if inside a SearchResult or SearchResultReference event. In this case, they represent URLs to contact to continue the search. References will be regular result references if inside the Result event or SearchComplete event. In this case, they represent the URLs to contact to complete the requested operation.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

ResultCode Property (LDAP Component)

This property includes the result code returned in the last server response.

Syntax

• C#
• VB.NET

public int ResultCode { get; }

Public ReadOnly Property ResultCode As Integer

Default Value

0

Remarks

This property contains the result code returned in the last server response. This is identical to the corresponding parameter provided by the last Result, SearchResult, or SearchComplete event.

Possible result codes are as follows:

All the result codes with the exception of success, compareFalse and compareTrue are to be treated as meaning the operation could not be completed in its entirety. Result codes from 16 to 21 indicate an AttributeProblem; codes 32, 33, 34, and 36 indicate a NameProblem; codes 48, 49, and 50 indicate a SecurityProblem; codes 51 to 54 indicate a ServiceProblem; and codes 64 to 69 and 71 indicate an UpdateProblem.

This property is read-only.

ResultDescription Property (LDAP Component)

This property includes the descriptive text returned in the last server response (if any).

Syntax

• C#
• VB.NET

public string ResultDescription { get; }

Public ReadOnly Property ResultDescription As String

Default Value

""

Remarks

This property contains the descriptive text returned in the last server response (if any). This is identical to the corresponding parameter provided by the last Result, SearchResult, or SearchComplete event.

This property is read-only.

ResultDN Property (LDAP Component)

This property includes the distinguished name returned in the last server response (if any).

Syntax

• C#
• VB.NET

public string ResultDN { get; }

Public ReadOnly Property ResultDN As String

Default Value

""

Remarks

This property contains the distinguished name returned in the last server response (if any). This is identical to the corresponding parameter provided by the last Result or SearchComplete event.

This property is read-only.

SearchDerefAliases Property (LDAP Component)

This property controls alias dereferencing during searching.

Syntax

• C#
• VB.NET

public LDAPSearchDerefAliases SearchDerefAliases { get; set; }

enum LDAPSearchDerefAliases {
  sdaNever,
  sdaInSearching,
  sdaFindingBaseObject,
  sdaAlways
}

Public Property SearchDerefAliases As LdapSearchDerefAliases

Enum LDAPSearchDerefAliases
  sdaNever
  sdaInSearching
  sdaFindingBaseObject
  sdaAlways
End Enum

Default Value

0

Remarks

This property controls the alias dereferencing during searching. The possible values are as follows:

The default is to never dereference aliases.

SearchReturnValues Property (LDAP Component)

This property controls whether the search operation returns values of attributes or only types.

Syntax

• C#
• VB.NET

public bool SearchReturnValues { get; set; }

Public Property SearchReturnValues As Boolean

Default Value

True

Remarks

This property controls whether the search operation returns values of attributes or only types. If only attributes are needed, disabling the property to return values will enhance performance.

SearchScope Property (LDAP Component)

This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations.

Syntax

• C#
• VB.NET

public LDAPSearchScopes SearchScope { get; set; }

enum LDAPSearchScopes {
  ssBaseObject,
  ssSingleLevel,
  ssWholeSubtree
}

Public Property SearchScope As LdapSearchScopes

Enum LDAPSearchScopes
  ssBaseObject
  ssSingleLevel
  ssWholeSubtree
End Enum

Default Value

2

Remarks

This property controls the scope of LDAP search operations. Possible values are as follows:

The default is to search the whole subtree.

SearchSizeLimit Property (LDAP Component)

This property includes the maximum number of entries that can be returned by the next search operation.

Syntax

• C#
• VB.NET

public int SearchSizeLimit { get; set; }

Public Property SearchSizeLimit As Integer

Default Value

0

Remarks

This property contains the maximum number of entries that can be returned by the next search operation. This limit is provided as a hint to the directory server. A value of 0 means that no size limits are in effect for the search.

SearchTimeLimit Property (LDAP Component)

This property includes a time limit for the next search operation (in seconds).

Syntax

• C#
• VB.NET

public int SearchTimeLimit { get; set; }

Public Property SearchTimeLimit As Integer

Default Value

0

Remarks

This property contains a time limit for the next search operation (in seconds). This limit is provided as a hint to the directory server. A value of 0 means that no time limits are in effect for the search.

ServerName Property (LDAP Component)

This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server.

Syntax

• C#
• VB.NET

public string ServerName { get; set; }

Public Property ServerName As String

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the directory server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

ServerPort Property (LDAP Component)

This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389).

Syntax

• C#
• VB.NET

public int ServerPort { get; set; }

Public Property ServerPort As Integer

Default Value

389

Remarks

This property contains the server port for the LDAP connection (the default is 389).

For the implicit Secure Sockets Layer (SSL), use port 636 (please refer to the SSLStartMode property for more information).

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

SortAttributes Property (LDAP Component)

This property includes a string of attribute names to sort on with optional relative matching rules.

Syntax

• C#
• VB.NET

public string SortAttributes { get; set; }

Public Property SortAttributes As String

Default Value

""

Remarks

This property contains a string of attribute names to sort on with optional relative matching rules. When set before a Search, entries returned by the server will be sorted according to SortAttributes. The format consists of one or more attribute names separated by spaces. Each attribute may be followed by an optional matching rule.

If matching rules are defined, they should be separated from the attribute names with a "/".

Normally, the values are returned in ascending order. If descending (reverse) order of sorting is desired, the attribute type must be preceded with a "-".

Following are examples:

LDAPControl.SortAttributes = "loginTime" LDAPControl.SortAttributes = "name/caseIgnoreSubstringsMatch age/numericStringSubstringsMatch" LDAPControl.SortAttributes = "cn age/1.3.6.1.4.1.1466.115.121.1.27" LDAPControl.SortAttributes = "-cn age/1.3.6.1.4.1.1466.115.121.1.27" Example 1. Matching Rules for Equality Filters:

SSLAcceptServerCert Property (LDAP Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (LDAP Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLEnabled Property (LDAP Component)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• C#
• VB.NET

public bool SSLEnabled { get; set; }

Public Property SSLEnabled As Boolean

Default Value

False

Remarks

This property specifies whether TLS/SSL is enabled in the component. When False (default), the component operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

SSLProvider Property (LDAP Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C#
• VB.NET

public LDAPSSLProviders SSLProvider { get; set; }

enum LDAPSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As LdapSSLProviders

Enum LDAPSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (LDAP Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SSLStartMode Property (LDAP Component)

This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public LDAPSSLStartModes SSLStartMode { get; set; }

enum LDAPSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Public Property SSLStartMode As LdapSSLStartModes

Enum LDAPSSLStartModes
  sslAutomatic
  sslImplicit
  sslExplicit
  sslNone
End Enum

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Timeout Property (LDAP Component)

This property includes the timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the component will wait for the operation to complete before returning control. The component will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Abandon Method (LDAP Component)

This method asks the server to abandon a request.

Syntax

• C#
• VB.NET

public void Abandon(int messageId);

Async Version
public async Task Abandon(int messageId);
public async Task Abandon(int messageId, CancellationToken cancellationToken);

Public Sub Abandon(ByVal MessageId As Integer)

Async Version
Public Sub Abandon(ByVal MessageId As Integer) As Task
Public Sub Abandon(ByVal MessageId As Integer, cancellationToken As CancellationToken) As Task

Remarks

This method asks the server to abandon the request specified by MessageId. The result of the operation is returned through the Result event.

Add Method (LDAP Component)

This method adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes properties.

Syntax

• C#
• VB.NET

public void Add();

Async Version
public async Task Add();
public async Task Add(CancellationToken cancellationToken);

Public Sub Add()

Async Version
Public Sub Add() As Task
Public Sub Add(cancellationToken As CancellationToken) As Task

Remarks

This method adds the entry specified by DN to the directory. All entries are required to have an objectClass attribute.

To add a new entry, first Bind with credentials that will allow you to perform the new addition. To add attributes instead of entries, use the Modify method instead. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the Attributes collection. Additional instances of the same attribute type should specify an attribute type of an empty string.

The result of the operation is returned through the Result event.

Example. Add a New Entry (including the multivalued objectClass attribute):

LDAPControl.DN = "uid=NewUser,ou=Employees,dc=server" LDAPControl.Attributes.Add(new LDAPAttribute("objectClass", "top")) LDAPControl.Attributes.Add(new LDAPAttribute("", "person")) LDAPControl.Attributes.Add(new LDAPAttribute("", "organizationalPerson")) LDAPControl.Attributes.Add(new LDAPAttribute("", "inetorgperson")) LDAPControl.Attributes.Add(new LDAPAttribute("sn", "UserName")) LDAPControl.Attributes.Add(new LDAPAttribute("cn", "New S. UserName")) LDAPControl.Attributes.Add(new LDAPAttribute("uid", "NewUser")) LDAPControl.Add()

Attr Method (LDAP Component)

This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute.

Syntax

• C#
• VB.NET

public string Attr(string attrType);

Async Version
public async Task<string> Attr(string attrType);
public async Task<string> Attr(string attrType, CancellationToken cancellationToken);

Public Function Attr(ByVal AttrType As String) As String

Async Version
Public Function Attr(ByVal AttrType As String) As Task(Of String)
Public Function Attr(ByVal AttrType As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method returns the value of the specified LDAP attribute. If the attribute does not exist, an empty string is returned.

Please refer to the Attributes collection for more information.

Bind Method (LDAP Component)

This method connects and binds to the directory server.

Syntax

• C#
• VB.NET

public void Bind();

Async Version
public async Task Bind();
public async Task Bind(CancellationToken cancellationToken);

Public Sub Bind()

Async Version
Public Sub Bind() As Task
Public Sub Bind(cancellationToken As CancellationToken) As Task

Remarks

This method connects and binds to the directory server. If the Password property has a value, it is used for authentication. If not, the bind is performed anonymously. Binding is often required on some directory servers, like Active Directory. The result of the operation is returned through the Result event.

Example. Binding:

LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.Password = "mypassword" LDAPControl.Bind() LDAPControl.DN = "Domain/Username" LDAPControl.Password = "mypassword" LDAPControl.Bind()

ChangePassword Method (LDAP Component)

This method changes the password for the specified user.

Syntax

• C#
• VB.NET

public void ChangePassword(string user, string oldPassword, string newPassword);

Async Version
public async Task ChangePassword(string user, string oldPassword, string newPassword);
public async Task ChangePassword(string user, string oldPassword, string newPassword, CancellationToken cancellationToken);

Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String)

Async Version
Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String) As Task
Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String, cancellationToken As CancellationToken) As Task

Remarks

This method changes the password for the specified user.

The User parameter is the name of the user for which the password will be changed. OldPassword specifies the current password and NewPassword specifies the new password.

Note: This operation can be performed only over the Secure Sockets Layer (SSL) port. Set ServerPort to the SSL port of the server (typically 636) before calling this method.

Note: If the user is an administrator, the old password is not required.

Compare Method (LDAP Component)

This method compares attributes and values with those of the entry specified by DN .

Syntax

• C#
• VB.NET

public void Compare();

Async Version
public async Task Compare();
public async Task Compare(CancellationToken cancellationToken);

Public Sub Compare()

Async Version
Public Sub Compare() As Task
Public Sub Compare(cancellationToken As CancellationToken) As Task

Remarks

This method compares attribute types and values specified via the Attributes collection, with the values in the directory for the entry specified by DN. The result of the operation is returned through the Result event.

Config Method (LDAP Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (LDAP Component)

This method connects to the directory server without performing any action.

Syntax

• C#
• VB.NET

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);

Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

Remarks

This method establishes a connection with the directory server specified by ServerName. In most cases, it is recommended to use the Bind method, which will both establish a connection and bind to the directory server.

This method may be useful in cases in which it is desirable to establish a connection without performing any operation (e.g., when testing connectivity).

Delete Method (LDAP Component)

Deletes an entry specified by DN from the directory server.

Syntax

• C#
• VB.NET

public void Delete();

Async Version
public async Task Delete();
public async Task Delete(CancellationToken cancellationToken);

Public Sub Delete()

Async Version
Public Sub Delete() As Task
Public Sub Delete(cancellationToken As CancellationToken) As Task

Remarks

This method deletes the entry specified by DN from the directory. The result of the operation is returned through the Result event.

DoEvents Method (LDAP Component)

This method processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

ExtendedRequest Method (LDAP Component)

This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation.

Syntax

• C#
• VB.NET

public void ExtendedRequest(string requestName, byte[] requestValue);

Async Version
public async Task ExtendedRequest(string requestName, byte[] requestValue);
public async Task ExtendedRequest(string requestName, byte[] requestValue, CancellationToken cancellationToken);

Public Sub ExtendedRequest(ByVal RequestName As String, ByVal RequestValue As String)

Async Version
Public Sub ExtendedRequest(ByVal RequestName As String, ByVal RequestValue As String) As Task
Public Sub ExtendedRequest(ByVal RequestName As String, ByVal RequestValue As String, cancellationToken As CancellationToken) As Task

Remarks

This method performs an LDAP V3 extended operation. RequestName must contain the object identifier of the operation, and RequestValue may contain an optional value.

Interrupt Method (LDAP Component)

This method interrupts the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListComputers Method (LDAP Component)

This method lists all computers in the directory.

Syntax

• C#
• VB.NET

public void ListComputers();

Async Version
public async Task ListComputers();
public async Task ListComputers(CancellationToken cancellationToken);

Public Sub ListComputers()

Async Version
Public Sub ListComputers() As Task
Public Sub ListComputers(cancellationToken As CancellationToken) As Task

Remarks

This method lists all computers in the directory. The ComputerList event will be fired once for each computer returned.

ListGroupMembers Method (LDAP Component)

This method lists all members of a group.

Syntax

• C#
• VB.NET

public void ListGroupMembers(string group);

Async Version
public async Task ListGroupMembers(string group);
public async Task ListGroupMembers(string group, CancellationToken cancellationToken);

Public Sub ListGroupMembers(ByVal group As String)

Async Version
Public Sub ListGroupMembers(ByVal group As String) As Task
Public Sub ListGroupMembers(ByVal group As String, cancellationToken As CancellationToken) As Task

Remarks

This method lists all members of the specified group. The UserList event will be fired once for each member returned.

ListGroups Method (LDAP Component)

This method list all groups in the directory.

Syntax

• C#
• VB.NET

public void ListGroups();

Async Version
public async Task ListGroups();
public async Task ListGroups(CancellationToken cancellationToken);

Public Sub ListGroups()

Async Version
Public Sub ListGroups() As Task
Public Sub ListGroups(cancellationToken As CancellationToken) As Task

Remarks

This method lists all groups in the directory. The GroupList event will be fired once for each group returned.

ListUserGroups Method (LDAP Component)

This method lists all groups a user is a part of.

Syntax

• C#
• VB.NET

public void ListUserGroups(string user);

Async Version
public async Task ListUserGroups(string user);
public async Task ListUserGroups(string user, CancellationToken cancellationToken);

Public Sub ListUserGroups(ByVal user As String)

Async Version
Public Sub ListUserGroups(ByVal user As String) As Task
Public Sub ListUserGroups(ByVal user As String, cancellationToken As CancellationToken) As Task

Remarks

This method lists all groups that the user specified by user is a part of. The GroupList event will fire once for each group the user is a part of.

Modify Method (LDAP Component)

This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN .

Syntax

• C#
• VB.NET

public void Modify();

Async Version
public async Task Modify();
public async Task Modify(CancellationToken cancellationToken);

Public Sub Modify()

Async Version
Public Sub Modify() As Task
Public Sub Modify(cancellationToken As CancellationToken) As Task

Remarks

This method performs an LDAP modify operation on the entry specified by DN. The attributes to modify should be set via the Attributes collection. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the Attributes collection. Additional instances of the same attribute type should specify an attribute type of an empty string.

The modification can be a replacement, an addition, or a deletion, depending on the ModOp field of the attribute;. The result of the operation is returned through the Result event.

Example. Modify an Entry (Replace an Attribute Value):

LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.Attributes.Add(New LDAPAttribute("url", "www.url1.net", LDAPAttributeModOps.amoReplace)) LDAPControl.Attributes.Add(New LDAPAttribute("", "www.url2.net", LDAPAttributeModOps.amoReplace)) LDAPControl.Modify()

ModifyRDN Method (LDAP Component)

This method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by DN .

Syntax

• C#
• VB.NET

public void ModifyRDN(string newRDN);

Async Version
public async Task ModifyRDN(string newRDN);
public async Task ModifyRDN(string newRDN, CancellationToken cancellationToken);

Public Sub ModifyRDN(ByVal NewRDN As String)

Async Version
Public Sub ModifyRDN(ByVal NewRDN As String) As Task
Public Sub ModifyRDN(ByVal NewRDN As String, cancellationToken As CancellationToken) As Task

Remarks

This method performs an LDAP modify RDN operation on the entry specified by DN.

NewRDN is the new RDN for the entry specified by DN

The result of the operation is returned through the Result event.

MoveToDN Method (LDAP Component)

This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN by changing its superior.

Syntax

• C#
• VB.NET

public void MoveToDN(string newSuperior);

Async Version
public async Task MoveToDN(string newSuperior);
public async Task MoveToDN(string newSuperior, CancellationToken cancellationToken);

Public Sub MoveToDN(ByVal NewSuperior As String)

Async Version
Public Sub MoveToDN(ByVal NewSuperior As String) As Task
Public Sub MoveToDN(ByVal NewSuperior As String, cancellationToken As CancellationToken) As Task

Remarks

This method performs an LDAP modify operation on the entry specified by DN by changing its superior.

Note: None of the entry's attributes will change. DeleteOldRDN property will be set to True to delete the old entry. The result of the operation is returned through the Result event.

PauseData Method (LDAP Component)

This method pauses data reception.

Syntax

• C#
• VB.NET

public void PauseData();

Async Version
public async Task PauseData();
public async Task PauseData(CancellationToken cancellationToken);

Public Sub PauseData()

Async Version
Public Sub PauseData() As Task
Public Sub PauseData(cancellationToken As CancellationToken) As Task

Remarks

This method pauses data reception when called. While data reception is paused, incoming data will not be processed and events will not fire. Call ProcessData to re-enable data reception.

ProcessData Method (LDAP Component)

This method re-enables data reception after a call to PauseData .

Syntax

• C#
• VB.NET

public void ProcessData();

Async Version
public async Task ProcessData();
public async Task ProcessData(CancellationToken cancellationToken);

Public Sub ProcessData()

Async Version
Public Sub ProcessData() As Task
Public Sub ProcessData(cancellationToken As CancellationToken) As Task

Remarks

This method re-enables data reception after a previous call to PauseData. Call this method to re-enable data reception and allow IPPacket to fire.

Note: This method is used only after previously calling PauseData. It does not need to be called to process data by default.

Reset Method (LDAP Component)

This method will reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

Search Method (LDAP Component)

This method searches the directory server using the base object specified in DN and the search filter SearchFilter .

Syntax

• C#
• VB.NET

public void Search(string searchFilter);

Async Version
public async Task Search(string searchFilter);
public async Task Search(string searchFilter, CancellationToken cancellationToken);

Public Sub Search(ByVal SearchFilter As String)

Async Version
Public Sub Search(ByVal SearchFilter As String) As Task
Public Sub Search(ByVal SearchFilter As String, cancellationToken As CancellationToken) As Task

Remarks

This method searches the directory server using the base object specified in the DN and the search filter specified in the SearchFilter parameter. Additional search parameters are specified through the SearchScope, SearchDerefAliases, SearchSizeLimit, SearchTimeLimit, and SearchReturnValues properties.

If Attributes are specified before starting a search, the server will return only those results that contain a value for the specified attributes.

Results are returned through zero or more SearchResult events, after which a SearchComplete event is fired.

Example 1. Searching for a User:

LDAPControl.DN = "ou=Employees,dc=server" LDAPControl.Search("uid=TThompson")

A Directory-Specific Entries (DSE) search will search for the attributes of the server. Example 2. DSE Search:

LDAPControl.DN = "" LDAPControl.SearchScope = 0 LDAPControl.Search("objectClass=*")

SearchFilter is a string representation of the Lightweight Directory Access Protocol (LDAP) search filter used for the search.

The format of the search filter is specified by RFC 1558 and is identical to the format used by most LDAP applications.

The following are examples of search filters, as provided in the RFC:

Example 3. Search Filters:

     (cn=Babs Jensen)
     (!(cn=Tim Howes))
     (&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))
     (o=univ*of*mich*)

The complete specification is given by the following BNF:

     <filter> ::= "(" <filtercomp> ")"
     <filtercomp> ::= <and> | <or> | <not> | <item>
     <and> ::= "&" <filterlist>
     <or> ::= "|" <filterlist>
     <not> ::= "!" <filter>
     <filterlist> ::= <filter> | <filter> <filterlist>
     <item> ::= <simple> | <present> | <substring>
     <simple> ::= <attr> <filtertype> <value>
     <filtertype> ::= <equal> | <approx> | <greater> | <less>
     <equal> ::= "="
     <approx> ::= "~="
     <greater> ::= ">="
     <less> ::= "<="
     <present> ::= <attr> "=*"
     <substring> ::= <attr> "=" <initial> <any> <final>
     <initial> ::= NULL | <value>
     <any> ::= "*" <starval>
     <starval> ::= NULL | <value> "*" <starval>
     <final> ::= NULL | <value>

<attr> is a string representing an attribute type as defined in RFC 1777. <value> is a string representing an attribute value, or part of one, and has the form defined in RFC 1779. If a <value> must contain one of the characters '*' or '(' or ')', these should be escaped by preceding them with the backslash '\' character.

Unbind Method (LDAP Component)

This method unbinds from the directory server.

Syntax

• C#
• VB.NET

public void Unbind();

Async Version
public async Task Unbind();
public async Task Unbind(CancellationToken cancellationToken);

Public Sub Unbind()

Async Version
Public Sub Unbind() As Task
Public Sub Unbind(cancellationToken As CancellationToken) As Task

Remarks

This method unbinds from the directory server and breaks the connection.

ComputerList Event (LDAP Component)

This event is fired for each computer entry returned.

Syntax

• C#
• VB.NET

public event OnComputerListHandler OnComputerList;

public delegate void OnComputerListHandler(object sender, LDAPComputerListEventArgs e);

public class LDAPComputerListEventArgs : EventArgs {
  public string name { get; }
  public string operatingSystem { get; }
  public string lastLogon { get; }
  public int logonCount { get; }
  public string dn { get; }
}

Public Event OnComputerList As OnComputerListHandler

Public Delegate Sub OnComputerListHandler(sender As Object, e As LDAPComputerListEventArgs)

Public Class LDAPComputerListEventArgs Inherits EventArgs
  Public ReadOnly Property name As String
  Public ReadOnly Property operatingSystem As String
  Public ReadOnly Property lastLogon As String
  Public ReadOnly Property logonCount As Integer
  Public ReadOnly Property dn As String
End Class

Remarks

This event is fired once for each computer returned when the ListComputers method is called.

Connected Event (LDAP Component)

Fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, LDAPConnectedEventArgs e);

public class LDAPConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As LDAPConnectedEventArgs)

Public Class LDAPConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (LDAP Component)

Fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, LDAPConnectionStatusEventArgs e);

public class LDAPConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As LDAPConnectionStatusEventArgs)

Public Class LDAPConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (LDAP Component)

Fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, LDAPDisconnectedEventArgs e);

public class LDAPDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As LDAPDisconnectedEventArgs)

Public Class LDAPDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (LDAP Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, LDAPErrorEventArgs e);

public class LDAPErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As LDAPErrorEventArgs)

Public Class LDAPErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ExtendedResponse Event (LDAP Component)

This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses.

Syntax

• C#
• VB.NET

public event OnExtendedResponseHandler OnExtendedResponse;

public delegate void OnExtendedResponseHandler(object sender, LDAPExtendedResponseEventArgs e);

public class LDAPExtendedResponseEventArgs : EventArgs {
  public int MessageId { get; }
  public string DN { get; }
  public int ResultCode { get; }
  public string ResultDescription { get; }
  public string ResponseName { get; }
  public string ResponseValue { get; }
  public byte[] ResponseValueB { get; }
}

Public Event OnExtendedResponse As OnExtendedResponseHandler

Public Delegate Sub OnExtendedResponseHandler(sender As Object, e As LDAPExtendedResponseEventArgs)

Public Class LDAPExtendedResponseEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As Integer
  Public ReadOnly Property DN As String
  Public ReadOnly Property ResultCode As Integer
  Public ReadOnly Property ResultDescription As String
  Public ReadOnly Property ResponseName As String
  Public ReadOnly Property ResponseValue As String
  Public ReadOnly Property ResponseValueB As Byte()
End Class

Remarks

The first four parameters are the same as the parameters of the Result event. ResponseName and ResponseValue are related to the corresponding parameters of the call to ExtendedRequest.

GroupList Event (LDAP Component)

This event is fired for each group entry returned.

Syntax

• C#
• VB.NET

public event OnGroupListHandler OnGroupList;

public delegate void OnGroupListHandler(object sender, LDAPGroupListEventArgs e);

public class LDAPGroupListEventArgs : EventArgs {
  public string name { get; }
  public string description { get; }
  public string dn { get; }
}

Public Event OnGroupList As OnGroupListHandler

Public Delegate Sub OnGroupListHandler(sender As Object, e As LDAPGroupListEventArgs)

Public Class LDAPGroupListEventArgs Inherits EventArgs
  Public ReadOnly Property name As String
  Public ReadOnly Property description As String
  Public ReadOnly Property dn As String
End Class

Remarks

This event is fired once for each group entry returned when either of the ListGroups or ListUserGroups methods are called.

PITrail Event (LDAP Component)

This event provides detailed information about the interaction with the server.

Syntax

• C#
• VB.NET

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, LDAPPITrailEventArgs e);

public class LDAPPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Description { get; }
  public string Message { get; }
}

Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As LDAPPITrailEventArgs)

Public Class LDAPPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Description As String
  Public ReadOnly Property Message As String
End Class

Remarks

The PITrail event provides detailed information about all communication with the server. This is useful for debugging purposes.

Direction specifies the origin of the data. Possible values are as follows:

• 0 - Client
• 1 - Server

Description is a short description of the current packet. This is human readable and useful for informational logging.

Message contains a hex-encoded version of the raw message. This represents the exact value sent over the wire.

Result Event (LDAP Component)

This event is fired for every server response, except for search responses.

Syntax

• C#
• VB.NET

public event OnResultHandler OnResult;

public delegate void OnResultHandler(object sender, LDAPResultEventArgs e);

public class LDAPResultEventArgs : EventArgs {
  public int MessageId { get; }
  public string DN { get; }
  public int ResultCode { get; }
  public string ResultDescription { get; }
}

Public Event OnResult As OnResultHandler

Public Delegate Sub OnResultHandler(sender As Object, e As LDAPResultEventArgs)

Public Class LDAPResultEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As Integer
  Public ReadOnly Property DN As String
  Public ReadOnly Property ResultCode As Integer
  Public ReadOnly Property ResultDescription As String
End Class

Remarks

The MessageId parameter identifies the corresponding request. ResultCode and ResultDescription show whether or not the operation was successful (on a successful operation, the ResultCode is 0). For a full list of possible result codes, see the ResultCode property.

SearchComplete Event (LDAP Component)

This event is fired upon completion of a search operation.

Syntax

• C#
• VB.NET

public event OnSearchCompleteHandler OnSearchComplete;

public delegate void OnSearchCompleteHandler(object sender, LDAPSearchCompleteEventArgs e);

public class LDAPSearchCompleteEventArgs : EventArgs {
  public int MessageId { get; }
  public string DN { get; }
  public int ResultCode { get; }
  public string ResultDescription { get; }
}

Public Event OnSearchComplete As OnSearchCompleteHandler

Public Delegate Sub OnSearchCompleteHandler(sender As Object, e As LDAPSearchCompleteEventArgs)

Public Class LDAPSearchCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As Integer
  Public ReadOnly Property DN As String
  Public ReadOnly Property ResultCode As Integer
  Public ReadOnly Property ResultDescription As String
End Class

Remarks

The MessageId parameter identifies the corresponding request. ResultCode and ResultDescription show whether the operation was successful (on a successful operation, the ResultCode is 0).

SearchPage Event (LDAP Component)

This event is fired for every page returned from a search operation.

Syntax

• C#
• VB.NET

public event OnSearchPageHandler OnSearchPage;

public delegate void OnSearchPageHandler(object sender, LDAPSearchPageEventArgs e);

public class LDAPSearchPageEventArgs : EventArgs {
  public int MessageId { get; }
  public string DN { get; }
  public int ResultCode { get; }
  public string ResultDescription { get; }
  public bool CancelSearch { get; set; }
}

Public Event OnSearchPage As OnSearchPageHandler

Public Delegate Sub OnSearchPageHandler(sender As Object, e As LDAPSearchPageEventArgs)

Public Class LDAPSearchPageEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As Integer
  Public ReadOnly Property DN As String
  Public ReadOnly Property ResultCode As Integer
  Public ReadOnly Property ResultDescription As String
  Public Property CancelSearch As Boolean
End Class

Remarks

This event is fired so the client can decide whether or not to continue with the Search operation. The signature is very similar to the SearchComplete event, with the addition of a CancelSearch parameter. If the search should be canceled (no more pages), the CancelSearch parameter should be set to True.

SearchResult Event (LDAP Component)

This event is fired for every entry returned from a search operation.

Syntax

• C#
• VB.NET

public event OnSearchResultHandler OnSearchResult;

public delegate void OnSearchResultHandler(object sender, LDAPSearchResultEventArgs e);

public class LDAPSearchResultEventArgs : EventArgs {
  public int MessageId { get; }
  public string DN { get; }
}

Public Event OnSearchResult As OnSearchResultHandler

Public Delegate Sub OnSearchResultHandler(sender As Object, e As LDAPSearchResultEventArgs)

Public Class LDAPSearchResultEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As Integer
  Public ReadOnly Property DN As String
End Class

Remarks

MessageId identifies the corresponding search request. DN contains the distinguished name of the entry. The attribute type and value provided in the Attributes collection show the list of retrieved attributes for the entry.

Every search operation results in a sequence of 0 or more SearchResult events and a sequence of 0 or more SearchResultReference events, which are followed by a SearchComplete event.

SearchResultReference Event (LDAP Component)

This event is fired for every result reference returned from a search operation.

Syntax

• C#
• VB.NET

public event OnSearchResultReferenceHandler OnSearchResultReference;

public delegate void OnSearchResultReferenceHandler(object sender, LDAPSearchResultReferenceEventArgs e);

public class LDAPSearchResultReferenceEventArgs : EventArgs {
  public int MessageId { get; }
  public string LdapUrl { get; }
}

Public Event OnSearchResultReference As OnSearchResultReferenceHandler

Public Delegate Sub OnSearchResultReferenceHandler(sender As Object, e As LDAPSearchResultReferenceEventArgs)

Public Class LDAPSearchResultReferenceEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As Integer
  Public ReadOnly Property LdapUrl As String
End Class

Remarks

MessageId identifies the corresponding search request. LdapUrl contains a URL reference to a server that can be used for continuing the search operation.

Every search operation results in a sequence of 0 or more SearchResult events and a sequence of 0 or more SearchResultReference events, which are followed by a SearchComplete event.

SSLServerAuthentication Event (LDAP Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, LDAPSSLServerAuthenticationEventArgs e);

public class LDAPSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As LDAPSSLServerAuthenticationEventArgs)

Public Class LDAPSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (LDAP Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, LDAPSSLStatusEventArgs e);

public class LDAPSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As LDAPSSLStatusEventArgs)

Public Class LDAPSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

UserList Event (LDAP Component)

This event is fired once for each user entry returned.

Syntax

• C#
• VB.NET

public event OnUserListHandler OnUserList;

public delegate void OnUserListHandler(object sender, LDAPUserListEventArgs e);

public class LDAPUserListEventArgs : EventArgs {
  public string name { get; }
  public string description { get; }
  public string lastLogon { get; }
  public string memberOf { get; }
  public string dn { get; }
}

Public Event OnUserList As OnUserListHandler

Public Delegate Sub OnUserListHandler(sender As Object, e As LDAPUserListEventArgs)

Public Class LDAPUserListEventArgs Inherits EventArgs
  Public ReadOnly Property name As String
  Public ReadOnly Property description As String
  Public ReadOnly Property lastLogon As String
  Public ReadOnly Property memberOf As String
  Public ReadOnly Property dn As String
End Class

Remarks

This event is fired once for each user entry returned when the ListGroupMembers method is called.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

LDAPAttribute Type

This types describes an attribute for the current entry.

Remarks

This type describes an attribute for the current Lightweight Directory Access Protocol (LDAP) entry. The ModOp field is used only in Modify operations.

Fields

Constructors

• C#
• VB.NET

public LDAPAttribute();

Public LDAPAttribute()

• C#
• VB.NET

public LDAPAttribute(string attributeType);

Public LDAPAttribute(ByVal AttributeType As String)

• C#
• VB.NET

public LDAPAttribute(string attributeType, string value);

Public LDAPAttribute(ByVal AttributeType As String, ByVal Value As String)

• C#
• VB.NET

public LDAPAttribute(string attributeType, string value, LDAPAttributeModOps modOp);

Public LDAPAttribute(ByVal AttributeType As String, ByVal Value As String, ByVal ModOp As LDAPAttributeModOps)

LDAPReference Type

This type includes a reference returned from the server.

Remarks

This type describes a Lightweight Directory Access Protocol (LDAP) reference, which may be queried inside the SearchResult, SearchResultReference, Result, or SearchComplete events.

When inside a SearchResult or SearchResultReference event, references will be a search result reference (that is, a continuation reference), in which case they represent the URLs to contact to continue the search.

When inside a Result or SearchComplete event, a reference will be a regular referral, in which case it represents the URL to contact to complete the requested operation.

Fields

Constructors

• C#
• VB.NET

public LDAPReference();

Public LDAPReference()

Config Settings (LDAP Component)

LDAP Config Settings

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (LDAP Component)

LDAP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

TCP/IP Errors