Table of Contents
LDAP4D at A Dog And His Boy

Initialization Methods

 

About this section...

This section describes the methods used to .



LDAP_InitComponent

Syntax:

result := LDAP_InitComponent (LicenceKeyString)

Description:

Initialize LDAP 4D with a license number.

Warning:

If you are using LDAP 4D with Internet Toolkit (ITK) ITK must also be initialized using the ITK_Init command.
If both license numbers are empty or invalid, ITK will run in demo mode and beep three times.
You only need to call this method once. Do so before any other call to LDAP 4D , LDAP 4D will work as if it is in Demo mode if an incorrect license key is entered.

Note:

If the license number is incorrect, LDAP4D will only do searches 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_InitComponent("bxv12345678...")
If ($err # 0)
  ALERT("LDAP 4D will only work for 1 hour!")
End If


LDAP_DeclareVars

Syntax:

LDAP_DeclareVars

Description:

Initialize process variables used internally by LDAP 4D.

Warning:

Calling this method will set the values of search counts and arrays to 0 and 0 elements respectively. Since the variables are all process variables, the scope of the "clearing" is only within the process in which it is invoked.

Params:

None

Example:

LDAP_DeclareVars


LDAP_GetPlugin

Syntax:

LDAP_GetPlugin

Description:

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

Warning:

If the plugin has not been set with a previous call to LDAP_SetPlugin, then it returns a default value of "4D".

Params:

In/Out

Parameter

Type

   

Example or note

<-

result

Longint

returns value set with LDAP_SetPlugin

 

Example:

$pluginName:=LDAP_GetPlugin


LDAP_SetPlugin

Syntax:

LDAP_SetPlugin (pluginName)

Description:

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

Warning:

Only valid values are "4D" or "ITK". If anything else is sent, it defaults to '4D". LDAP4D needs both plugins to compile, but you can ship with only one.

Params:

In/Out

Parameter

Type

   

Example or note

->

pluginName

Text

valid values are "4D" or "ITK", "NTK"

LDAP_SetPlugin("4D")

Note: can use "NTK" with v2.0b1

Example:

LDAP_SetPlugin("ITK")

LDAP_SetTimeout

Syntax:

LDAP_SetTimeout (timeoutInSeconds)

Description:

Number of seconds that LDAP4D waits on a port. Note that this is not the same thing as the timeLimit parm in LDAP_SearchRequest.

Warning:

 

Params:

In/Out

Parameter

Type

   

Example or note

->

timeoutInSeconds

Longint

 

LDAP_SetTimeout(30)

Example:

LDAP_SetTimeout(30)


Back to top