IPWorks Auth 2022 ActiveX Edition
Version 22.0 [Build 8369]

LDAP Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

LDAP

Remarks

The LDAP Control supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over 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 via the Config method.

The LDAP Control 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 control is specifying the ServerName, a DN (distinguished name) to bind as, and optionally a Password. Then you can call one or more of the control 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 properties. 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 control operates synchronously by default (waits for a response before returning control to the caller); however, the control 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 control with short descriptions. Click on the links for further details.

AcceptDataThis property enables or disables data reception from the server.
AttrCountThe number of records in the Attr arrays.
AttrTypeThis property contains the attribute type for the current entry.
AttrModOpThis property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation.
AttrValueThis property contains the attribute value for the current entry.
AuthMechanismThis property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server.
ConnectedThis shows whether the control is connected.
DeleteOldRDNThis property controls whether the old RDN (Relative Distinguished Name) should be deleted.
DNThis property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations.
FirewallAutoDetectThis property tells the control whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the control.
LDAPVersionThe version of the Lightweight Directory Access Protocol (LDAP) used.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageIdThis property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request.
PageSizeThis property includes the maximum number of results per page for the Search method.
PasswordThis property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server.
ReferenceCountThe number of records in the Reference arrays.
ReferenceURLThe url of the LDAP reference.
ResultCodeThis property includes the result code returned in the last server response.
ResultDescriptionThis property includes the descriptive text returned in the last server response (if any).
ResultDNThis property includes the distinguished name returned in the last server response (if any).
SearchDerefAliasesThis property controls alias dereferencing during searching.
SearchReturnValuesThis property controls whether the search operation returns values of attributes or only types.
SearchScopeThis property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations.
SearchSizeLimitThis property includes the maximum number of entries that can be returned by the next search operation.
SearchTimeLimitThis property includes a time limit for the next search operation (in seconds).
ServerNameThis property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server.
ServerPortThis property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389).
SortAttributesThis property includes a string of attribute names to sort on with optional relative matching rules.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLStartModeDetermines how the control starts the SSL negotiation.
TimeoutA timeout for the control.

Method List


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

AbandonThis method asks the server to abandon a request.
AddThis method adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes properties.
AttrThis method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute.
BindThis method connects and binds to the directory server.
ChangePasswordThis method changes the password for the specified user.
CompareThis method compares attributes and values with those of the entry specified by DN .
ConfigSets or retrieves a configuration setting.
ConnectThis method connects to the remote host without performing any action.
DeleteDeletes an entry specified by DN from the directory server.
DoEventsProcesses events from the internal message queue.
ExtendedRequestThis method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation.
InterruptInterrupt the current method.
ListComputersThis method lists all computers in the directory.
ListGroupMembersThis method lists all members of a group.
ListGroupsThis method list all groups in the directory.
ListUserGroupsThis method lists all groups a user is a part of.
ModifyThis method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN .
ModifyRDNThis method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by DN .
MoveToDNThis method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN by changing its superior.
PauseDataThis method pauses data reception.
ProcessDataThis method reenables data reception after a call to PauseData .
ResetReset the control.
SearchThis method searches the directory server using the base object specified in DN and the search filter SearchFilter .
UnbindThis method unbinds from the directory server.

Event List


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

ComputerListThis event is fired for each computer entry returned.
ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionStatusThis event is fired to indicate changes in the connection state.
DisconnectedThis event is fired when a connection is closed.
ErrorInformation about errors during data delivery.
ExtendedResponseThis event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses.
GroupListThis event is fired for each group entry returned.
PITrailThis event provides detailed information about the interaction with the server.
ResultThis event is fired for every server response, except for search responses.
SearchCompleteThis event is fired upon completion of a search operation.
SearchPageThis event is fired for every page returned from a search operation.
SearchResultThis event is fired for every entry returned from a search operation.
SearchResultReferenceThis event is fired for every result reference returned from a search operation.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
UserListThis event is fired once for each user entry returned.

Config Settings


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

DomainControllerReturns the name of the domain controller.
FriendlyGUIDWhether to return GUID attribute values in a human readable format.
FriendlySIDWhether to return SID attribute values in a human readable format.
RequestControlsControls to include in the request.
ResponseControlsControls present in the response.
SingleResultModeDetermines how ResultDN behaves.
UseDefaultDCWhether to connect to the default Domain Controller when calling Bind.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the control whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the control binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.
UseInternalSecurityAPITells the control whether or not to use the system security libraries or an internal implementation.

AcceptData Property (LDAP Control)

This property enables or disables data reception from the server.

Syntax

ldapcontrol.AcceptData[=boolean]

Default Value

True

Remarks

This property enables or disables data reception from the server. Setting the property to False, temporarily disables data reception. Setting the property to True, reenables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

AttrCount Property (LDAP Control)

The number of records in the Attr arrays.

Syntax

ldapcontrol.AttrCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at AttrCount - 1.

This property is not available at design time.

Data Type

Integer

AttrType Property (LDAP Control)

This property contains the attribute type for the current entry.

Syntax

ldapcontrol.AttrType(AttrIndex)[=string]

Default Value

""

Remarks

This property contains the attribute type for the current entry.

If the value of AttributeType is an empty string, then the AttrValue that contains the corresponding value is part of a set of values, and the attribute type for the set is specified in the previous attribute of the properties with a nonempty AttributeType.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is not available at design time.

Data Type

String

AttrModOp Property (LDAP Control)

This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation.

Syntax

ldapcontrol.AttrModOp(AttrIndex)[=integer]

Possible Values

amoAdd(0), 
amoDelete(1), 
amoReplace(2)

Default Value

0

Remarks

This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation.

Possible values include the following:

amoAdd (0)amoAdd will add the specified value to the given attribute, creating the attribute if it does not already exist.
amoDelete (1)amoDelete will delete the specified value from the given attribute. If all or none of the values are specified for the value, the entire attribute will be deleted; otherwise, only the specific value(s) listed will be removed.
amoReplace (2)amoReplace will replace all existing values of the given attribute with the new values specified.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is not available at design time.

Data Type

Integer

AttrValue Property (LDAP Control)

This property contains the attribute value for the current entry.

Syntax

ldapcontrol.AttrValue(AttrIndex)[=string]

Default Value

""

Remarks

This property contains the attribute value for the current entry.

If the value is part of a set of values, the AttributeType that contains the corresponding attribute type is an empty string, and the attribute type for the set is specified in the previous attribute of the properties with a nonempty AttributeType.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttrValueB.

This property is not available at design time.

Data Type

Binary String

AuthMechanism Property (LDAP Control)

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

Syntax

ldapcontrol.AuthMechanism[=integer]

Possible Values

lamSimple(0), 
lamDigestMD5(1), 
lamNegotiate(2), 
lamKerberos(6), 
lamSASLExternal(7)

Default Value

0

Remarks

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

0 (lamSimple - default) Plaintext authentication
1 (lamDigestMD5) DIGEST-MD5 authentication
2 (lamNegotiate) NTLM/Negotiate authentication
6 (lamKerberos) Kerberos authentication
7 (lamSASLExternal) SASL EXTERNAL authentication

Data Type

Integer

Connected Property (LDAP Control)

This shows whether the control is connected.

Syntax

ldapcontrol.Connected[=boolean]

Default Value

False

Remarks

This property is used to determine whether or not the control is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

DeleteOldRDN Property (LDAP Control)

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

Syntax

ldapcontrol.DeleteOldRDN[=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.

Data Type

Boolean

DN Property (LDAP Control)

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

Syntax

ldapcontrol.DN[=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"

Data Type

String

FirewallAutoDetect Property (LDAP Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

ldapcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (LDAP Control)

This property determines the type of firewall to connect through.

Syntax

ldapcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (LDAP Control)

This property contains the name or IP address of firewall (optional).

Syntax

ldapcontrol.FirewallHost[=string]

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (LDAP Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

ldapcontrol.FirewallPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (LDAP Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

ldapcontrol.FirewallPort[=integer]

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (LDAP Control)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

ldapcontrol.FirewallUser[=string]

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

Idle Property (LDAP Control)

The current status of the control.

Syntax

ldapcontrol.Idle

Default Value

True

Remarks

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

This property is read-only.

Data Type

Boolean

LDAPVersion Property (LDAP Control)

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

Syntax

ldapcontrol.LDAPVersion[=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.

Data Type

Integer

LocalHost Property (LDAP Control)

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

Syntax

ldapcontrol.LocalHost[=string]

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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 multi-homed 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.

Data Type

String

MessageId Property (LDAP Control)

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

Syntax

ldapcontrol.MessageId[=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 control increments this property automatically after each request.

This property is not available at design time.

Data Type

Integer

PageSize Property (LDAP Control)

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

Syntax

ldapcontrol.PageSize[=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.

Data Type

Integer

Password Property (LDAP Control)

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

Syntax

ldapcontrol.Password[=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.

Data Type

String

ReferenceCount Property (LDAP Control)

The number of records in the Reference arrays.

Syntax

ldapcontrol.ReferenceCount

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at ReferenceCount - 1.

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

Data Type

Integer

ReferenceURL Property (LDAP Control)

The url of the LDAP reference.

Syntax

ldapcontrol.ReferenceURL(ReferenceIndex)

Default Value

""

Remarks

The url of the LDAP reference. If inside a SearchResult or SearchResultReference event, it represents a URL to contact to continue the search. If inside the Result event or SearchComplete event it represents the URL to contact in order to complete the requested operation.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

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

Data Type

String

ResultCode Property (LDAP Control)

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

Syntax

ldapcontrol.ResultCode

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:

0 success
1 operationsError
2 protocolError
3 timeLimitExceeded
4 sizeLimitExceeded
5 compareFalse
6 compareTrue
7 authMethodNotSupported
8 strongAuthRequired
9 reserved
10 referral
11 adminLimitExceeded
12 unavailableCriticalExtension
13 confidentialityRequired
14 saslBindInProgress
16 noSuchAttribute
17 undefinedAttributeType
18 inappropriateMatching
19 constraintViolation
20 attributeOrValueExists
21 invalidAttributeSyntax
32 noSuchObject
33 aliasProblem
34 invalidDNSyntax
35 reserved for undefined isLeaf
36 aliasDereferencingProblem
48 inappropriateAuthentication
49 invalidCredentials
50 insufficientAccessRights
51 busy
52 unavailable
53 unwillingToPerform
54 loopDetect
64 namingViolation
65 objectClassViolation
66 notAllowedOnNonLeaf
67 notAllowedOnRDN
68 entryAlreadyExists
69 objectClassModsProhibited
70 reserved for CLDAP
71 affectsMultipleDSAs

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.

Data Type

Integer

ResultDescription Property (LDAP Control)

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

Syntax

ldapcontrol.ResultDescription

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.

Data Type

String

ResultDN Property (LDAP Control)

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

Syntax

ldapcontrol.ResultDN

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.

Data Type

String

SearchDerefAliases Property (LDAP Control)

This property controls alias dereferencing during searching.

Syntax

ldapcontrol.SearchDerefAliases[=integer]

Possible Values

sdaNever(0), 
sdaInSearching(1), 
sdaFindingBaseObject(2), 
sdaAlways(3)

Default Value

0

Remarks

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

sdaNever (0) Do not dereference aliases in searching or in locating the base object of the search.
sdaInSearching (1) Dereference aliases in subordinates of the base object in searching, but not in locating the base object of the search.
sdaFindingBaseObject (2) Dereference aliases in locating the base object of the search, but not when searching subordinates of the base object.
sdaAlways (3) Dereference aliases both in searching and in locating the base object of the search.

The default is to never dereference aliases.

Data Type

Integer

SearchReturnValues Property (LDAP Control)

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

Syntax

ldapcontrol.SearchReturnValues[=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.

Data Type

Boolean

SearchScope Property (LDAP Control)

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

Syntax

ldapcontrol.SearchScope[=integer]

Possible Values

ssBaseObject(0), 
ssSingleLevel(1), 
ssWholeSubtree(2)

Default Value

2

Remarks

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

ssBaseObject (0) Search only the base object.
ssSingleLevel (1) Search only one level, including objects directly below the base object, but not the base object.
ssWholeSubtree (2) Search the whole subtree, including the base object.

The default is to search the whole subtree.

Data Type

Integer

SearchSizeLimit Property (LDAP Control)

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

Syntax

ldapcontrol.SearchSizeLimit[=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.

Data Type

Integer

SearchTimeLimit Property (LDAP Control)

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

Syntax

ldapcontrol.SearchTimeLimit[=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.

Data Type

Integer

ServerName Property (LDAP Control)

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

Syntax

ldapcontrol.ServerName[=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.

Data Type

String

ServerPort Property (LDAP Control)

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

Syntax

ldapcontrol.ServerPort[=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.

Data Type

Integer

SortAttributes Property (LDAP Control)

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

Syntax

ldapcontrol.SortAttributes[=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:

1.3.6.1.4.1.1466.115.121.1.38objectIdentifierMatch
1.3.6.1.4.1.1466.115.121.1.12distinguishedNameMatch
1.3.6.1.4.1.1466.115.121.1.15caseIgnoreMatch
1.3.6.1.4.1.1466.115.121.1.36numericStringMatch
1.3.6.1.4.1.1466.115.121.1.41caseIgnoreListMatch
1.3.6.1.4.1.1466.115.121.1.27integerMatch
1.3.6.1.4.1.1466.115.121.1.6bitStringMatch
1.3.6.1.4.1.1466.115.121.1.50telephoneNumberMatch
1.3.6.1.4.1.1466.115.121.1.43presentationAddressMatch
1.3.6.1.4.1.1466.115.121.1.34uniqueMemberMatch
1.3.6.1.4.1.1466.115.121.1.42protocolInformationMatch
1.3.6.1.4.1.1466.115.121.1.24generalizedTimeMatch
1.3.6.1.4.1.1466.115.121.1.26caseExactIA5Match
1.3.6.1.4.1.1466.115.121.1.26caseIgnoreIA5Match

Example 2. Matching Rules for Inequality Filters:

1.3.6.1.4.1.1466.115.121.1.24 generalizedTimeOrderingMatch
1.3.6.1.4.1.1466.115.121.1.15 caseIgnoreOrderingMatch

Example 3. Matching Rules for Substring Filters:

1.3.6.1.4.1.1466.115.121.1.58 caseIgnoreSubstringsMatch
1.3.6.1.4.1.1466.115.121.1.58 telephoneNumberSubstringsMatch
1.3.6.1.4.1.1466.115.121.1.58 numericStringSubstringsMatch

Example 4. Matching Rules for Subschema Attributes:

1.3.6.1.4.1.1466.115.121.1.27integerFirstComponentMatch
1.3.6.1.4.1.1466.115.121.1.38objectIdentifierFirstComponentMatch

Data Type

String

SSLAcceptServerCertEncoded Property (LDAP Control)

This is the certificate (PEM/base64 encoded).

Syntax

ldapcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (LDAP Control)

This is the certificate (PEM/base64 encoded).

Syntax

ldapcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (LDAP Control)

This is the name of the certificate store for the client certificate.

Syntax

ldapcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (LDAP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

ldapcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (LDAP Control)

This is the type of certificate store for this certificate.

Syntax

ldapcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used the control will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (LDAP Control)

This is the subject of the certificate used for client authentication.

Syntax

ldapcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLEnabled Property (LDAP Control)

Whether TLS/SSL is enabled.

Syntax

ldapcontrol.SSLEnabled[=boolean]

Default Value

False

Remarks

This setting specifies whether TLS/SSL is enabled in the control. When False (default) the control 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.

Data Type

Boolean

SSLProvider Property (LDAP Control)

This specifies the SSL/TLS implementation to use.

Syntax

ldapcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control 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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.

Additional Notes

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

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (LDAP Control)

This is the certificate (PEM/base64 encoded).

Syntax

ldapcontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

SSLStartMode Property (LDAP Control)

Determines how the control starts the SSL negotiation.

Syntax

ldapcontrol.SSLStartMode[=integer]

Possible Values

sslAutomatic(0), 
sslImplicit(1), 
sslExplicit(2), 
sslNone(3)

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

0 (sslAutomatic)If the remote port is set to the standard plaintext port of the protocol (where applicable), the control will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)The control will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone - default)No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Data Type

Integer

Timeout Property (LDAP Control)

A timeout for the control.

Syntax

ldapcontrol.Timeout[=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 control will wait for the operation to complete before returning control. The control will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The control 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 control fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

Data Type

Integer

Abandon Method (LDAP Control)

This method asks the server to abandon a request.

Syntax

ldapcontrol.Abandon MessageId

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 Control)

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

Syntax

ldapcontrol.Add 

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 properties. 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.AttributeCount = 7 LDAPControl.AttributeType(0) = "objectClass" LDAPControl.AttributeValue(0) = "top" LDAPControl.AttributeType(1) = "" LDAPControl.AttributeValue(1) = "person" LDAPControl.AttributeType(2) = "" LDAPControl.AttributeValue(2) = "organizationalPerson" LDAPControl.AttributeType(3) = "" LDAPControl.AttributeValue(3) = "inetOrgPerson" LDAPControl.AttributeType(4) = "sn" LDAPControl.AttributeValue(4) = "UserName" LDAPControl.AttributeType(5) = "cn" LDAPControl.AttributeValue(5) = "New S. UserName" LDAPControl.AttributeType(6) = "uid" LDAPControl.AttributeValue(6) = "NewUser" LDAPControl.Add()

Attr Method (LDAP Control)

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

Syntax

ldapcontrol.Attr AttrType

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 properties for more information.

Bind Method (LDAP Control)

This method connects and binds to the directory server.

Syntax

ldapcontrol.Bind 

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 Control)

This method changes the password for the specified user.

Syntax

ldapcontrol.ChangePassword user, oldPassword, newPassword

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 Control)

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

Syntax

ldapcontrol.Compare 

Remarks

This method compares attribute types and values specified via the Attributes properties, 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 Control)

Sets or retrieves a configuration setting.

Syntax

ldapcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 Control)

This method connects to the remote host without performing any action.

Syntax

ldapcontrol.Connect 

Remarks

This method establishes a connection with the remote host specified by URL, but it does not send a request. In most cases, it is recommended to use the appropriate method, such as Get or Post, which will both establish a connection and send a request.

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 Control)

Deletes an entry specified by DN from the directory server.

Syntax

ldapcontrol.Delete 

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 Control)

Processes events from the internal message queue.

Syntax

ldapcontrol.DoEvents 

Remarks

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

ExtendedRequest Method (LDAP Control)

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

Syntax

ldapcontrol.ExtendedRequest RequestName, RequestValue

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 Control)

Interrupt the current method.

Syntax

ldapcontrol.Interrupt 

Remarks

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

ListComputers Method (LDAP Control)

This method lists all computers in the directory.

Syntax

ldapcontrol.ListComputers 

Remarks

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

ListGroupMembers Method (LDAP Control)

This method lists all members of a group.

Syntax

ldapcontrol.ListGroupMembers group

Remarks

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

ListGroups Method (LDAP Control)

This method list all groups in the directory.

Syntax

ldapcontrol.ListGroups 

Remarks

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

ListUserGroups Method (LDAP Control)

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

Syntax

ldapcontrol.ListUserGroups user

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 Control)

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

Syntax

ldapcontrol.Modify 

Remarks

This method performs an LDAP modify operation on the entry specified by DN. The attributes to modify should be set via the Attributes properties. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the Attributes properties. 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.AttributeCount = 2 LDAPControl.AttributeType(0) = "url" LDAPControl.AttributeValue(0) = "www.url1.net" LDAPControl.AttributeModOp(0) = amoReplace LDAPControl.AttributeType(0) = "" LDAPControl.AttributeValue(0) = "www.url2.net" LDAPControl.AttributeModOp(0) = amoReplace LDAPControl.Modify()

ModifyRDN Method (LDAP Control)

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

Syntax

ldapcontrol.ModifyRDN NewRDN

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 Control)

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

Syntax

ldapcontrol.MoveToDN NewSuperior

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 Control)

This method pauses data reception.

Syntax

ldapcontrol.PauseData 

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 reenable data reception.

ProcessData Method (LDAP Control)

This method reenables data reception after a call to PauseData .

Syntax

ldapcontrol.ProcessData 

Remarks

This method reenables data reception after a previous call to PauseData. Call this method to reenable 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 Control)

Reset the control.

Syntax

ldapcontrol.Reset 

Remarks

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

Search Method (LDAP Control)

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

Syntax

ldapcontrol.Search SearchFilter

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 Control)

This method unbinds from the directory server.

Syntax

ldapcontrol.Unbind 

Remarks

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

ComputerList Event (LDAP Control)

This event is fired for each computer entry returned.

Syntax

Sub ldapcontrol_ComputerList(name As String, operatingSystem As String, lastLogon As String, logonCount As Integer, dn As String)

Remarks

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

Connected Event (LDAP Control)

This event is fired immediately after a connection completes (or fails).

Syntax

Sub ldapcontrol_Connected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (LDAP Control)

This event is fired to indicate changes in the connection state.

Syntax

Sub ldapcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

Remarks

The ConnectionStatus 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:

Firewall connection complete.
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Disconnected Event (LDAP Control)

This event is fired when a connection is closed.

Syntax

Sub ldapcontrol_Disconnected(StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Error Event (LDAP Control)

Information about errors during data delivery.

Syntax

Sub ldapcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

ErrorCode contains an error code and Description 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 Control)

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

Syntax

Sub ldapcontrol_ExtendedResponse(MessageId As Integer, DN As String, ResultCode As Integer, ResultDescription As String, ResponseName As String, ResponseValue As String)

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 Control)

This event is fired for each group entry returned.

Syntax

Sub ldapcontrol_GroupList(name As String, description As String, dn As String)

Remarks

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

PITrail Event (LDAP Control)

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

Syntax

Sub ldapcontrol_PITrail(Direction As Integer, Description As String, Message As String)

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 Control)

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

Syntax

Sub ldapcontrol_Result(MessageId As Integer, DN As String, ResultCode As Integer, ResultDescription As String)

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 Control)

This event is fired upon completion of a search operation.

Syntax

Sub ldapcontrol_SearchComplete(MessageId As Integer, DN As String, ResultCode As Integer, ResultDescription As String)

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 Control)

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

Syntax

Sub ldapcontrol_SearchPage(MessageId As Integer, DN As String, ResultCode As Integer, ResultDescription As String, CancelSearch As Boolean)

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 Control)

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

Syntax

Sub ldapcontrol_SearchResult(MessageId As Integer, DN As String)

Remarks

MessageId identifies the corresponding search request. DN contains the distinguished name of the entry. The attribute type and value provided in the Attributes properties 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 Control)

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

Syntax

Sub ldapcontrol_SearchResultReference(MessageId As Integer, LdapUrl As String)

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 Control)

Fired after the server presents its certificate to the client.

Syntax

Sub ldapcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 Control)

Shows the progress of the secure connection.

Syntax

Sub ldapcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

UserList Event (LDAP Control)

This event is fired once for each user entry returned.

Syntax

Sub ldapcontrol_UserList(name As String, description As String, lastLogon As String, memberOf As String, dn As String)

Remarks

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

Config Settings (LDAP Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

LDAP Config Settings

DomainController:   Returns the name of the domain controller.

This configuration setting may be queried to return the name of the default domain controller in Active Directory domains.

Note: This functionality is available only in Windows.

Note: This functionality is not available in Java.

FriendlyGUID:   Whether to return GUID attribute values in a human readable format.

When inspecting object attributes, this configuration setting determines whether GUID attributes, such as "objectGUID" are returned as binary objects or converted into a human readable string, such as "708d9374-d64a-49b2-97ea-489ddc717703". When set to True, a friendly string value is returned. When set to False (default), a binary object is returned.

FriendlySID:   Whether to return SID attribute values in a human readable format.

When inspecting object attributes, this configuration setting determines whether SID attributes, such as "objectSid" are returned as binary objects or converted into a human readable string, such as "S-1-5-21-4272240814-246508344-1325542772-12464". When set to True, a friendly string value is returned. When set to False (default), a binary object is returned.

RequestControls:   Controls to include in the request.

This configuration setting may be used to specify LDAP controls in the request. The expected format is a space-separated sequence of OIDs and hex-encoded values. For instance, a single control with a value of 04 may be sent as follows: ldap.Config("RequestControls=1.2.826.0.1.3344810.2.3 04"); To send a control without a value, specify only the OID. For instance: ldap.Config("RequestControls=1.3.6.1.4.1.42.2.27.8.5.1");

ResponseControls:   Controls present in the response.

This configuration setting holds the LDAP controls returned in the response (if any). The format is a space-separated sequence of OIDs and hex-encoded values. For instance: Log(ldap.Config("ResponseControls")); The output may look something like this: 1.2.826.0.1.3344810.2.3 04

SingleResultMode:   Determines how ResultDN behaves.

When set to True, ResultDN will return only the next result when queried. If no more results are found, querying ResultDN will return an empty string. This is useful in environments in which events cannot be used, such as ASP. For instance:

LDAP1.DN = Request("basedn") LDAP1.Config ("SingleResultMode=true") LDAP1.Search Request("query") Dim Result, i Response.Write "<hr><pre>" Do Result = LDAP1.ResultDN if (Result <> "") then Response.Write Result + "<br>" 'The attributes of each entry are in the AttrType and AttrValue property arrays For i = 0 To LDAP1.AttrCount - 1 Response.Write LDAP1.AttrType(i) + ": " + LDAP1.AttrValue(i) + "<br>" Next End If Loop While Result <> "" Response.Write "</pre>"

UseDefaultDC:   Whether to connect to the default Domain Controller when calling Bind.

If this configuration setting is set to True, ServerName does not need to be set before calling Bind in Active Directory domains. When True, the control will query the system for the default domain controller and attempt to establish a connection with that server.

Note: This functionality is available only in Windows.

Note: This functionality is not available in Java.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the control will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the control whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by controls that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the control fails with an error.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the control returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost setting 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 multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the control binds.

This must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the control will use IPv4 exclusively. When set to 1, the control will use IPv6 exclusively. To instruct the control to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

UseInternalSecurityAPI:   Tells the control whether or not to use the system security libraries or an internal implementation.

By default the control will use the system security libraries to perform cryptographic functions where applicable. Setting this to tells the control to use the internal implementation instead of using the system's security API.

Trappable Errors (LDAP Control)

LDAP Errors

20119    Firewall error. Error message contains detailed description.
20302    Index out of range.
20332    Bad attribute index.
20335    Busy executing current method.
20336    Error in search filter.
20337    Protocol error.

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

TCPClient Errors

20101    You cannot change the RemotePort at this time. A connection is in progress.
20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
20103    The RemoteHost address is invalid (0.0.0.0).
20105    Already connected. If you want to reconnect, close the current connection first.
20107    You cannot change the LocalPort at this time. A connection is in progress.
20108    You cannot change the LocalHost at this time. A connection is in progress.
20113    You cannot change MaxLineLength at this time. A connection is in progress.
20117    RemotePort cannot be zero. Please specify a valid service port number.
20118    You cannot change the UseConnection option while the control is active.
20136    Operation would block.
20202    Timeout.
20212    Action impossible in control's present state.
20213    Action impossible while not connected.
20214    Action impossible while listening.
20302    Timeout.
20303    Could not open file.
20435    Unable to convert string to selected CodePage.
21106    Already connecting. If you want to reconnect, close the current connection first.
21118    You need to connect first.
21120    You cannot change the LocalHost at this time. A connection is in progress.
21121    Connection dropped by remote host.

TCP/IP Errors

25005    [10004] Interrupted system call.
25010    [10009] Bad file number.
25014    [10013] Access denied.
25015    [10014] Bad address.
25023    [10022] Invalid argument.
25025    [10024] Too many open files.
25036    [10035] Operation would block.
25037    [10036] Operation now in progress.
25038    [10037] Operation already in progress.
25039    [10038] Socket operation on non-socket.
25040    [10039] Destination address required.
25041    [10040] Message too long.
25042    [10041] Protocol wrong type for socket.
25043    [10042] Bad protocol option.
25044    [10043] Protocol not supported.
25045    [10044] Socket type not supported.
25046    [10045] Operation not supported on socket.
25047    [10046] Protocol family not supported.
25048    [10047] Address family not supported by protocol family.
25049    [10048] Address already in use.
25050    [10049] Can't assign requested address.
25051    [10050] Network is down.
25052    [10051] Network is unreachable.
25053    [10052] Net dropped connection or reset.
25054    [10053] Software caused connection abort.
25055    [10054] Connection reset by peer.
25056    [10055] No buffer space available.
25057    [10056] Socket is already connected.
25058    [10057] Socket is not connected.
25059    [10058] Can't send after socket shutdown.
25060    [10059] Too many references, can't splice.
25061    [10060] Connection timed out.
25062    [10061] Connection refused.
25063    [10062] Too many levels of symbolic links.
25064    [10063] File name too long.
25065    [10064] Host is down.
25066    [10065] No route to host.
25067    [10066] Directory not empty
25068    [10067] Too many processes.
25069    [10068] Too many users.
25070    [10069] Disc Quota Exceeded.
25071    [10070] Stale NFS file handle.
25072    [10071] Too many levels of remote in path.
25092    [10091] Network subsystem is unavailable.
25093    [10092] WINSOCK DLL Version out of range.
25094    [10093] Winsock not loaded yet.
26002    [11001] Host not found.
26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
26005    [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2022 ActiveX Edition - Version 22.0 [Build 8369]