Netscape Directory Server Programmer's Guide: Function Reference

Complete Contents
Getting Started
Chapter 1 Understanding Server Plug-Ins
Chapter 2 Writing and Compiling Plug-Ins
Chapter 3 Calling the Front-End API Functions
Chapter 4 Quick Start
Chapter 5 Writing Database Plug-Ins
Chapter 6 Writing Pre/Post-Operation Plug-Ins
Chapter 7 Defining Functions for LDAP Operations
Chapter 8 Defining Functions for Database Operations
Chapter 9 Defining Functions for Authentication
Chapter 10 Writing Entry Store/Fetch Plug-Ins
Chapter 11 Writing Extended Operation Plug-Ins
Chapter 12 Writing Matching Rule Plug-Ins
Chapter 13 Data Type and Structure Reference
Chapter 14 Function Reference
Chapter 15 Parameter Reference
Glossary

slapi_modrdn_internal()

Performs an LDAP modify RDN operation to rename a directory entry from your plug-in.

#include "slapi-plugin.h"
Slapi_PBlock *slapi_modrdn_internal( char * olddn,
char * newrdn, int deloldrdn, LDAPControl **controls,
int log_change);

The function has the following parameters:
olddn
Distinguished name (DN) of the entry that you want to rename.

newdn
New relative distinguished name (RDN) of the entry.

deloldrdn
Specifies whether or not you want to remove the old RDN from the entry.
If 1, removes the old RDN.
If 0, leaves the old RDN as an attribute of the entry.

controls
A NULL-terminated array of LDAP controls (see "LDAPControl" on page 193) that you want applied to the modify RDN operation.

log_change
Specifies whether or not you want to log the changes to the replication log.
If 1, write the changes to the replication log.
If 0, do not write the changes to the replication log.

Returns. A new parameter block (see "Slapi_PBlock" on page 215) with the following parameter set:

SLAPI_PLUGIN_INTOP_RESULT specifies the LDAP result code for the internal LDAP operation (for example, LDAP_SUCCESS if the operation is successful or LDAP_PARAM_ERROR if an invalid parameter is used).

If the DN of the entry has a suffix that is not served by the Directory Server, SLAPI_PLUGIN_INTOP_RESULT is set to LDAP_REFERRAL.

Description. This function allows you to rename an entry to the directory from a plug-in function. The arguments for this function are similar to the arguments for the standard ldap_modrdn2() function in the Netscape LDAP C SDK.

Unlike the standard LDAP modify RDN operation, no LDAP result code to a client. Instead, the result code is placed in a parameter block that is returned by the function.

© Copyright 1998 Netscape Communications Corporation