Table of Contents | Previous | Next | Index

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

ldap_abandon()

Cancels ("abandons") an asynchronous LDAP operation that is in progress.

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_abandon_ext() instead.

Syntax 

#include <ldap.h>
int ldap_abandon( LDAP *ld, int msgid );

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. 

msgid

Message ID of an LDAP operation

Returns

One of the following values:

Description

The ldap_abandon() function cancels ("abandons") an asynchronous LDAP operation that is in progress.

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

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

Example

The following example cancels an ldap_url_search() operation, abandoning the results of the operation. 

LDAP *ld;
char *url = "ldap://ldap.itd.umich.edu/c=US?o,description?one?o=umich";
int msgid;
...
/* Initiate a search operation */
msgid = ldap_url_search( ld, url, 0 );
...
/* Abandon the search operation */
if ( ldap_abandon( ld, msgid ) != LDAP_SUCCESS ) {
   ldap_perror( ld, "ldap_abandon" );
   return( 1 );
}
...

See Also

ldap_abandon_ext().

Table of Contents | Previous | Next | Index

Last Updated: 10/01/98 17:06:23