21.8. slapi_register_supported_control()

Description

Registers the specified control with the server. This function associates the control with an object identification (OID). When the server receives a request that specifies this OID, the server makes use of this information to determine if the control is supported by the server or its plug-ins.

Syntax

#include "slapi-plugin.h"
void slapi_register_supported_control( char *controloid, unsigned long controlops );

Parameters

This function takes the following parameters:

controloid
OID of the control you want to register.
controlops
Operation to which the control is applicable.
SLAPI_OPERATION_BIND
The specified control applies to the LDAP bind operation.
SLAPI_OPERATION_UNBIND
The specified control applies to the LDAP unbind operation.
SLAPI_OPERATION_SEARCH
The specified control applies to the LDAP search operation.
SLAPI_OPERATION_MODIFY
The specified control applies to the LDAP modify operation.
SLAPI_OPERATION_ADD
The specified control applies to the LDAP add operation.
SLAPI_OPERATION_DELETE
The specified control applies to the LDAP delete operation.
SLAPI_OPERATION_MODDN
The specified control applies to the LDAP modify DN operation.
SLAPI_OPERATION_MODRDN
The specified control applies to the LDAPv3 modify RDN operation.
SLAPI_OPERATION_COMPARE
The specified control applies to the LDAP compare operation.
SLAPI_OPERATION_ABANDON
The specified control applies to the LDAP abandon operation.
SLAPI_OPERATION_EXTENDED
The specified control applies to the LDAPv3 extended operation.
SLAPI_OPERATION_ANY
The specified control applies to any LDAP operation.
SLAPI_OPERATION_NONE
The specified control applies to none of the LDAP operations.
You can specify a combination of values by bitwise OR-ing the values together. For example: SLAPI_OPERATION_ADD | SLAPI_OPERATION_DELETE