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

slapi_rename_internal_set_pb()

Prepares a parameter block for an internal modify RDN operation.

Syntax

#include "slapi-plugin.h"
int slapi_rename_internal_set_pb(Slapi_PBlock *pb,
    const char *olddn, const char *newrdn,
    const char *newsuperior, int deloldrdn,
    LDAPControl **controls, const char *uniqueid,
    Slapi_ComponentId *plugin_identity, int operation_flags);

Parameters

This function takes the following parameters:

pb

Parameter block for the internal modify RDN operation

olddn

Distinguished Name of the entry to rename

newrdn

New Relative Distinguished name to apply

newsuperior

DN of parent after renaming

deloldrdn

1 to delete the old RDN, 0 to retain the old RDN

controls

Array of controls to request for the modify RDN operation

uniqueid

Unique identifier for the entry if using this rather than DN

plugin_identity

Plug-in identifier obtained from SLAPI_PLUGIN_IDENTITY during plug-in initialization

operation_flags

NULL or SLAPI_OP_FLAG_NEVER_CHAIN

Returns

This function returns 0 if successful. Otherwise, it returns an LDAP error code.

Description

This function prepares a parameter block for use with slapi_modrdn_internal_pb().

Memory Concerns

Allocate the parameter block using slapi_pblock_new() before calling this function.

Directory Server does not free the parameters you passed to this function.

Free the parameter block after calling slapi_modrdn_internal_pb() .

See Also

slapi_modrdn_internal_pb()

slapi_pblock_new()