Table of Contents | Previous | Next | Index

Netscape Directory SDK 3.0 for C Programmer’s Guide
Chapter 18 Functions

ldap_add_s()

Adds a new entry to the directory synchronously.

Note that this is an older function that is included in the LDAP API for backward-compatibility. If you are writing a new LDAP client, use ldap_add_ext_s() instead.

Syntax

#include <ldap.h>
int ldap_add_s( LDAP *ld, const char *dn, LDAPMod **attrs );

Parameters

This function has the following parameters:

ld
Connection handle, which is a pointer to an LDAP structure containing information about the connection to the LDAP server.

dn
Distinguished name (DN) of the entry to add. With the exception of the leftmost component, all components of the distinguished name (for example, o=organization or c=country) must already exist.

attrs
Pointer to a NULL-terminated array of pointers to LDAPMod structures representing the attributes of the new entry.

Returns

See the result code documentation for the ldap_add_ext_s() function for a list of possible return codes for the LDAP add operation.

Description

The ldap_add_s() function adds a new entry to the directory synchronously.

A newer version of this function, ldap_add_ext_s(), is available in this release of the LDAP API. ldap_add_s() (the older version of the function) is included only for backward-compatibility. If you are writing a new LDAP client, use ldap_add_ext_s() instead of ldap_add_s().

If you want more information on ldap_add_s(), refer to the LDAP C SDK 1.0 Programmer's Guide.

Example

The following example adds a new entry to the directory.

#include <ldap.h>

...

LDAP *ld;

LDAPMod *list_of_attrs[4];

LDAPMod attribute1, attribute2, attribute3;

/* Distinguished name of the new entry. Note that "o=Airius.com" and "ou=People, o=Airius.com" must already exist in the directory. */

char *dn = "uid=bjensen, ou=People, o=Airius.com";

/* To add a "person" entry, you must specify values for the sn, cn, and objectClass attributes. (These are required attributes.) */

char *sn_values[] = { "Jensen", NULL };

/* To specify multiple values for an attribute, add the different values to the array. */

char *cn_values[] = { "Barbara Jensen", "Babs Jensen", NULL };

/* The object class for a "person" entry is "inetOrgPerson", which is a subclass of "top", "person", and "organizationalPerson". You should add all of these classes as values of the objectClass attribute. */

char *objectClass_values[] = { "top", "person", "organizationalPerson", "inetOrgPerson", NULL };

...

/* Specify the value and type of each attribute in separate LDAPMod structures */

attribute1.mod_type = "sn";

attribute1.mod_values = sn_values;

attribute2.mod_type = "cn";

attribute2.mod_values = cn_values;

attribute3.mod_type = "objectClass";

attribute3.mod_values = objectClass_values;

/* Add the pointers to these LDAPMod structures to an array */

list_of_attrs[0] = &attribute1;

list_of_attrs[1] = &attribute2;

list_of_attrs[2] = &attribute3;

list_of_attrs[3] = NULL;

...

/* Add the user "Barbara Jensen" */

if ( ldap_add_s( ld, dn, list_of_attrs ) != LDAP_SUCCESS ) {

   ldap_perror( ld, "ldap_add_s" );

   return( 1 );

...