ldap_msgfree()

Syntax

#include <ldap.h>
int ldap_msgfree( LDAPMessage *lm );

Parameters

lm	ID of the result to be freed from memory.

Returns

• If successful, returns the type of result freed. Possible types of results are listed below.

  LDAP_RES_BIND	Results from an LDAP bind operation.
  LDAP_RES_SEARCH_ENTRY	Entry returned by an LDAP search operation.
  LDAP_RES_SEARCH_RESULT	Results from an LDAP search operation.
  LDAP_RES_MODIFY	Results from an LDAP modify operation.
  LDAP_RES_ADD	Results from an LDAP add operation.
  LDAP_RES_DELETE	Results from an LDAP delete operation.
  LDAP_RES_MODRDN, LDAP_RES_RENAME	Results from an LDAP modify DN operation.
  LDAP_RES_COMPARE	Results from an LDAP compare operation.
  LDAP_RES_SEARCH_REFERENCE	Search reference returned by an LDAP search operation.
  LDAP_RES_EXTENDED	Results from an LDAP extended operation.
  LDAP_RES_ANY	Results from any asynchronous LDAP operation.

• If unsuccessful, returns the LDAP error code for the operation. (See "Result Codes" on page 691 for a complete listing.)
• If the operation times out, returns LDAP_SUCCESS.

Example

#include <stdio.h>

#include <ldap.h>

...

LDAP *ld;

LDAPMessage *result;

char *my_searchbase = "o=Airius.com";

char *my_filter = "(sn=Jensen)";

char *get_attr[] = { "cn", "mail", NULL };

...

/* Search the directory */

if ( ldap_search_s( ld, my_searchbase, LDAP_SCOPE_SUBTREE, my_filter, get_attr, 0, &result ) != LDAP_SUCCESS ) {

   ldap_perror( ld, "ldap_search_s" );

   return( 1 );

}

...

/* Free the results when done */

ldap_msgfree( result );

...

See Also

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