Sun Java System Directory Server Enterprise Edition 6.0 Developer's Guide

slapi_register_supported_control()

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 const *controloid,
    unsigned long controlops );

Parameters

This function takes the following parameters:

controloid

OID of the control you want to register.

controlops

Operation that the control is applicable to.

The controlops argument can have one or more of the following values:

ID 

Description 

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 LDAP v3 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 ORing the values together (for example, SLAPI_OPERATION_ADD | SLAPI_OPERATION_DELETE).

See Also

slapi_control_present()

slapi_entry_get_uniqueid()