Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY CUSTOMIZATION, Manual

Page: 282 / 612

Functions for Dealing with Controls
282 Netscape Directory Server Plug-In Programmer’s Guide • December 2003
Returns
This function returns
LDAP_SUCCESS
(LDAP result code) if successful.
Description
This function creates an
LDAPCotnrol
structure based on a
BerElement
, an OID,
and a criticality flag. The
LDAPControl
that is created can be used in LDAP client
requests or internal operations.
Memory Concerns
The contents of the
ber
parameter are consumed by this function. Because of this,
the caller should not free the
BerElement
once a successful call has been made to
slapi_build_control()
.
The
LDAPControl
pointer that is returned in
ctrlp
should be freed by calling
ldap_control_free()
, which is an LDAP API function (see the Netscape LDAP
SDK for C Programmer’s Guide).
See Also
slapi_build_control_from_berval()
slapi_build_control()
ldap_control_free()
slapi_build_control_from_berval()
Creates an
LDAPControl
structure based on a
struct berval
, an OID, and a
criticality flag.
Syntax
#include “slapi-plugin.h”
int slapi_build_control_from_berval( char *oid,
struct berval *bvp,char iscritical, LDAPControl **ctrlp );
Parameters
This function takes the following parameters:
oid
The OID (object identifier) for the control that is to be created.
bvp
A
struct berval
that contains the control value. Pass
NULL
if
the control has no value.
iscritical
The criticality flag. If non-zero, the control will be marked as
critical. If 0, it will not be marked as critical.