Table of Contents
LDAP4D Directory at A Dog And His Boy

LDAP4D Directory - Initialization
 

About this section...

This section describes the methods used to .


LDAP_InitDirectory

Syntax:

result := LDAP_InitDirectory ( LicenceKeyString:T )

Description:

Initialize LDAP 4D Directory with a license number.

Warning:

 You only need to call this method once. Do so before any other call to LDAP4D Directory, LDAP4D Directory will work as if it is in Demo mode if an incorrect license key is entered.

Note:

If the license number is incorrect, LDAP4D Directory will only respond to searches requests and binds for 1 hour.
Also, the LicenseKeyString is required - if you call this method without one, it is interpreted as unregistering the component, and subsequent calls will act as if in demo mode.

Params:

In/Out

Parameter

Type

   

Example or note

->

LicenceKeyString

Text

First license number

none

<-

result

Longint

success or failure

0 =valid license key

Example: 

$err := LDAP_InitDirectory("bxv12345678...")
If ($err # 0)
  ALERT("LDAP 4D Directory will only work for 1 hour!")
End If


LDAPD_DeclareVars

Syntax:

LDAPD_DeclareVars

Description:

Initialize process variables used internally by LDAP 4D Directory.

Warning:

Calling this method will set the values of process variables, the scope of the "clearing" is only within the process in which it is invoked.

Params:

None

Example: 

LDAPD_DeclareVars


LDAPD_RequireBind

Syntax:

LDAPD_RequireBind ( {requireBind:Boolean} )

Description:

Get/Set whether a bind is required.

Warning:

None

Params:

In/Out

Parameter

Type

   

Example or note

  ->
 RequireBind
 Boolean
Optional
<-

result

Boolean

returns current interprocess value of bind requirement.

 

Example: 

If (LDAPD_RequireBind)	
	DoSomething 
Else
	DoSomethingElse
End if


LDAPD_BindArraysSet

Syntax:

LDAPD_BindArraysSet ( userNames:Pointer; passwords:Pointer; groupNames:Pointer )

Description:

Set the username, password,

Warning:

All three arrays must be of the same size.

Params:

In/Out

Parameter

Type

   

Example or note

  ->
 Usernames Array
 Pointer
 pointer to text array of usernames
  ->
 Passwords Array
 Pointer
 pointer to text array of passwords
  ->
 Groups Array
 Pointer
 pointer to text array of groups
<-

result

Longint

success or failure

 0 = success

Example: 

$result:=LDAPD_BindArraysSet(->atUsernames;->atPasswords;->atGroups)



LDAPD_Plugin

Syntax:

LDAPD_Plugin ( {pluginName:T} )

Description:

Declare which plugin is being used for TCP/IP communication.

Warning:

Only valid value is "NTK".

Params:

In/Out

Parameter

Type

   

Example or note

  ->
 pluginName Text Get/Set plugin being used

Optional. only valid value is "NTK"
  <- 

pluginName   

Text


Example: 

$pluginName:=LDAPD_Plugin

LDAPD_Timeout

Syntax:

LDAPD_Timeout ( {timeoutInSeconds:LI} )

Description:

Get/Set the number of seconds that LDAP4D Directory waits on a port. 

Warning:

 

Params:

In/Out

Parameter

Type

   

Example or note

  ->
 timeoutInSeconds Longint
Optional
   <-

timeoutInSeconds

Longint

 

LDAP_SetTimeout(30)

Example: 

LDAPD_Timeout(30)

LDAPD_SearchBase

Syntax:

LDAPD_SearchBase ( {searchbase:T} )

Description:

Get/SetNumber the searchbase that will be required for searches on this directory.
None is required, but it will "look" more LDAPish to outside queries.

Warning:

 

Params:

In/Out

Parameter

Type

   

Example or note

  ->
 search base
 Text
Optional.
This can be any text string. Though it will have no effect on results returned, it's probably best to make it look like an LDAP server base.
<-

search base

Text

 


Example: 

$tSearchBase:= LDAPD_SearchBase

LDAPD_ResumeHandlers

Syntax:

LDAPD_ResumeHandlers

Description:

Wake up running handlers to allow them to proceed or quit.

Warning:

 

Params:

In/Out

Parameter

Type

   

Example or note

none



 


Example: 

LDAPD_ResumeHandlers

LDAPD_EndDirectoryProcess

Syntax:

LDAPD_EndDirectoryProcess

Description:

A wrapper for LDAPD_QuitDirectory (True) so that it can be called from a menu.

Warning:

 

Params:

In/Out

Parameter

Type

   

Example or note

none



 


Example: 

LDAPD_End DirectoryProcess

LDAPD_QuitDirectory

Syntax:

LDAPD_QuitDirectory ( {quitDirectory:Boolean} )

Description:

Get/Set status of directory. This process variable is checked in handlers to see if the processes should terminate.

Warning:

 

Params:

In/Out

Parameter

Type

   

Example or note

  ->
 quitDirectory
 Boolean
Optional
<-  

quitDirectory

Boolean

 


Example: 

$flag:=LDAPD_QuitDirectory(True)

Back to top