Using the Netscape Directory SDK for C

Table of Contents | Previous | Next | Index

Netscape Directory SDK 3.0 for C Programmer’s Guide

Chapter 2
Using the Netscape Directory SDK for C

This chapter describes the Lightweight Directory Access Protocol (LDAP) Application Programming Interface (API) and the Netscape Directory SDK for C.

The chapter contains the following sections:

Understanding the LDAP API

Working with the Netscape Directory SDK for C

Understanding the LDAP API

The LDAP API consists of a set of functions that you can use to build LDAP clients. The LDAP API includes functions that allow you to connect to LDAP servers and perform standard LDAP functions, including:

searching for and retrieving a list of entries

adding new entries

updating entries

deleting entries

renaming entries

For example, if you are writing an email application, you can use LDAP API functions to retrieve email addresses from an LDAP server.

The API functions allow you to perform LDAP operations synchronously or asynchronously.

You can call a synchronous function if you want to wait for the operation to complete before receiving the return value of a function.

If you want to perform other work while waiting for an operation to complete, you can call an asynchronous function and poll the LDAP client library to check the status of the operation.

The LDAP API also includes functions that implement the LDAP v3 protocol. For example, you can call functions to request extended operations from an LDAP v3 server.

Subsequent chapters in this manual explain how to use the LDAP API functions.

Working with the Netscape Directory SDK for C

The Netscape Directory SDK for C includes the header files and libraries for the LDAP API functions. You can include these header files and link to these libraries to enable your application to use LDAP.

Including the LDAP Header File

When writing your LDAP client, make sure to include the ldap.h header file.

#include <ldap.h>

The ldap.h header file declares the LDAP API functions.

If your client calls any of the LDAP SSL functions, make sure to include the ldap_ssl.h header file:

#include <ldap_ssl.h>

Compiling Clients on UNIX

The Netscape Directory SDK for C has an include directory (which contains the header files that you need to include) and a lib directory (which contains the shared libraries and object that you should link to).

When compiling clients on UNIX platforms, you need to link to the LDAP API shared library. The name of the library is different for the SSL-enabled and non-SSL versions of the SDK:

If you have downloaded the SSL-enabled version of the Netscape Directory SDK for C, the LDAP API shared library is named libldapssl30.so on Solaris, IRIX, and AIX, and libldapssl30.sl on HP-UX.

For example, on Solaris, if you are compiling source code in the examples directory, check your Makefile for the following link flags:

      -L../lib -lldapssl30

If you have downloaded the non-SSL version of the Netscape Directory SDK for C, the LDAP API shared library is named libldap30.so on Solaris, IRIX, and AIX, and libldap30.sl on HP-UX.

For example, on Solaris, if you are compiling source code in the examples directory, check your Makefile for the following link flags:

      -L../lib -lldap30

If you linked to the shared library, you need to make sure that the LDAP client can find the library. Do one of the following:

Make sure that the LDAP API shared library file (for example, libldap30.so on Solaris) in a standard location (such as the /usr/lib directory).

On some platforms, if you have compiled your client with certain flags set, you can set an environment variable to specify the run-time path to check when loading libraries. You can set this variable to the location of the LDAP API library.

For example, on Solaris and IRIX, you can use the LD_LIBRARY_PATH environment variable. On HP-UX, you can use the SHLIB_PATH environment variable if you use the -Wl,+s+b flag when compiling and linking. On AIX, you can use the LIBPATH environment variable.

Use a link flag that specifies the path where the executable can find the library. For example, on Solaris, you can use the -R flag to specify the path where the executable can find the library.

See the Makefile in the examples directory for examples of additional flags that you may need to specify when compiling and linking your LDAP client.

Compiling Clients on Windows

When compiling clients on Windows platforms, make sure to define _CONSOLE (if you are writing a console application) or _WINDOWS (if you are writing a standard Windows application).

Make sure to link to the LDAP API import library. The name of the library is different for the SSL-enabled and non-SSL versions of the SDK:

If you have downloaded the SSL-enabled version of the Netscape Directory SDK for C, the import library is named nsldapssl32v30.lib for Microsoft compilers.

If you have downloaded the non-SSL version of the Netscape Directory SDK for C, the import library is named nsldap32v30.lib for Microsoft compilers.

nsldap32v30bc.lib is the name of the import library for Borland compilers.

Make sure to copy the nsldap32v30.dll dynamic link library (for the non-SSL verison of the SDK) or nsldapssl32v30.dll (for the SSL-enabled version of the SDK) to a directory where your client can find it.

NOTE: Some Netscape servers (such as the Netscape Directory Server) install a different version of the nsldap32v30.dll in the Windows system32 directory. Make sure that your client finds the version of the DLL that is included with the Netscape Directory SDK for C before finding the version in the system32 directory. (For example, you can copy the SDK DLL to the same directory as your client application.)

During run-time, your client searches for the LDAP API dynamic link library in the following locations:

The directory from which the application loaded.

The current directory.

The 32-bit Windows system directory. (In Windows 95, this directory is typically windows\system. In Windows NT, this directory is typically winnt\system32.)

Note that a version of the LDAP API DLL may already exist in this directory. (For example, Netscape servers install a different version of this DLL in this directory.) To avoid potential conflicts, you should not install the DLL in this directory.

(Windows NT only) The 16-bit Windows system directory. (This directory is typically winnt\system.)

The Windows directory.

The directories listed in the PATH environment variable.

Compiling Clients on Mac OS

When compiling clients on Mac OS, you need to link to the NSLDAPLib shared library.

You also need to make sure that the LDAP client can find the shared library. Do one of the following:

Copy the NSLDAPLib shared library to the folder containing your client executable file.

Drag the shared library to your System Folder.

Table of Contents | Previous | Next | Index

Last Updated: 10/01/98 17:02:17