ldap_msgfree

The ldap_msgfree function frees the results obtained from a previous call to ldap_result, or to one of the synchronous search routines.

ULONG ldap_msgfree(
  LDAPMessage* res 
);

Parameters

res

[in] The result, or chain of results to free.

Return Values

If the function succeeds, it returns a constant that describes the type of message freed. One of the following values is the type of message just freed:

LDAP_RES_ADD

LDAP_RES_BIND

LDAP_RES_COMPARE

LDAP_RES_DELETE

LDAP_RES_EXTENDED

LDAP_RES_MODDN

LDAP_RES_MODIFY

LDAP_RES_SEARCH_ENTRY

LDAP_RES_SEARCH_REFERENCE

LDAP_RES_SEARCH_RESULT

Remarks

Call ldap_msgfree to free the result structure pointed to by the res parameter. The return value indicates the type of result freed.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP4 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in Winldap.h.
  Library: Use Wldap32.lib.

See Also

Functions, ldap_result