ldap_create_sstatus_control

Creates and encodes a search status control.

LDAP Version:v3

Library:*ldapsdk.*

NDS Version:8.xx or higher

Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

  #include <ldap.h>ldap_create_sstatus_control (
           LDAP             *ld,
           LDAPSstatCtrl  *sstatctrl,
           int              isCritical,
         LDAPControl     **ctrlp )

Parameters

ld: (IN) Points to the handle for the LDAP session obtained from a call to ldap_init().
sstatctrl: (IN) The address of an structure whose contents are used to construct the value of the control that is created.
isCritical: (IN) Indicates the criticality of the control to the operation. 0 indicates that the control is not critical to the operation and a non-zero values indicates that the control is critical to the operation.
ctrlp: (OUT) Returns a pointer to the created LDAPControl. This control is free from calling the ldap_control_free() after returning the pointer.

Return Values

0x00	LDAP_SUCCESS
Non-zero	Failure. See LDAP Return Codes

Remarks

The ldap_create_geteffective_control creates a search status control, that can be used as the server control parameter in the ldap_search_ext and the ldap_search_ext_s functions.