LDAP4D Directory - Access Methods

LDAP4D Directory - Access Methods
	LDAPD_BindCompleted LDAPD_HandlerCount LDAPD_iError LDAPD_NumAttributesRequested LDAPD_NumOperators LDAPD_Request_Application LDAPD_Port LDAPD_SearchFilter LDAPD_tResultErrorMessage
*About this section...*	This section describes the methods which provide get/set access to process variables used by LDAP4D Directory. This approach is was taken due to the scope of variables in the 4D Component model and that it also allows more abstraction of the variables.

LDAPD_BindCompleted

Syntax:

result := LDAPD_BindCompleted ( {bBindCompleted:Boolean} )

Description:

Get/Set whether a bind was completed successfully in this handler. If binds are required as set by LDAPD_RequireBind, it will check the username and password sent in bind attempts. against those set with LDAPD_BindArraysSet.

Warning:

Note:

Params:

In/Out	Parameter	Type		Example or note
->	bindCompleted	Boolean	Indicate whether successful bind was completed in the handler.	optional
<-	bindCompleted	Boolean	Indicates whether successful bind was completed in the handler.

Example:

$flag := LDAP_BindCompleted

LDAPD_HandlerCount

Syntax:

result := LDAP_HandlerCount ( {numhandlers:LI} )

Description:

Get/Set number of handlers used by directory.

Warning:

The number of handlers should be set before starting the directory. If not called, the default value is 5.

Note:

Params:

In/Out	Parameter	Type		Example or note
->	numHandlers	Longint	Number of handler processes to be used.	optional
<-	result	Longint	Number of handler processes in operation

Example:

$iNumHandlers :=LDAP_HandlerCount

LDAPD_iError

Syntax:

result:= LDAPD_iError

Description:

Returns the current value of errors created by calls to LDAP4D Directory methods.

Warning:

none

Note:

Params:

In/Out

Parameter

Type

Example or note

<-
result

Longint

Current value of internal errors.

Generally, 0 = noErr.

Example:

$err := LDAP_iError

LDAPD_NumAttributesRequested

Syntax:

iResult:= LDAPD_NumAttributesRequested

Description:

Number of attributes requested by a search.

Warning:

Only valid immediately after search request is successfully parsed.

Note:

Params:

In/Out

Parameter

Type
Description
Example or note

None

<-
result

Longint

Count of responses returned from a search.

Example:

$iNumbAttributes := LDAPD_NumAttributesRequested

LDAPD_NumOperators

Syntax:

result := LDAPD_NumOperators

Description:

The number of operators parsed out of LDAP filter in a search request. This is used to build the search in 4D that responds to LDAP search requests.

Warning:

Only valid immediately after a search request is successfully parsed.

Note:

Params:

In/Out	Parameter	Type		Example or note
<-	result	Longint	Number of operators in search request.

Example:

$num := LDAPD_NumOperators

LDAPD_Port

Syntax:

result := LDAPD_Port ( {iPort:LI} )

Description:

Get/set the port used by LDAP4D Directory. Default is 1389.

Warning:

none

Note:

389 is the "standard" LDAP port.

Params:

In/Out	Parameter	Type		Example or note
->	port	Longint	Port on which the server is listening.	optional
<-	port	Longint

Example:

$port :=LDAPD_Port(1389)

LDAPD_RequestApplication ( applicationNum:LI )

Syntax:

$iAPPLICATION := LDAPD_RequestApplication (0x0061)

Description:

Determine the APPLICATION of an LDAP message

Warning:

Note:

Used only in LDAPDu_RequestHandler when parsing an LDAP Message.

Params:

In/Out	Parameter	Type		Example or note
->	Application	Longint	The application.	0x0060, 0x0063
<-	ApplicationType	Text	Type of application parsed from LDAP Message	"BindRequest", "SearchRequest", etc.

Example:

$tResultCodeDescription := LDAP_RequestApplication

LDAPD_SearchFilter

Syntax:

result := LDAPD_SearchFilter

Description:

The search filter and LDAP attributes requested by successful parse of incoming search request

Warning:

Only valid immediately after search request is successfully parsed.

Note:

A typical search filter would be - (|(givenname=col*)(sn=col*)(mail=col*)(cn=col*))
See RFC 2254 - The String Representation of LDAP Search Filters for details

Params:

In/Out	Parameter	Type		Example or note
<-	searchFilter	Text	LDAP search filter.

Example:

$tText := LDAPD_SearchFilter

LDAPD_tResultErrorMessage

Syntax:

tMessage := LDAPD_tResultErrorMessage

Description:

Error message generated in LDAP4D Directory methods.

Warning:

Note:

Params:

In/Out	Parameter	Type		Example or note
<-	ErrorMessage	Text	Error that occurred when running anLDAP4D Directory method.

Example:

$tText := LDAPD_tResultErrorMessage