ldap_msgfree

Frees each message in the result chain pointed to by the res parameter and returns the type of the last message in the chain.

LDAP Version:v2 or higher
Library:*ldapsdk.*
NDS Version:7.xx or higher
Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

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

Parameters

res

(IN) Points to the message chain to free. If res is set to NULL, nothing is done.

Return Values

>0x60

Success

0x00

Nothing was done.

Remarks

The ldap_msgfree function is used to free the memory allocated by the ldap_result, ldap_search_s, ldap_search_st, and ldap_search_ext_s functions and returns the type of the last message in the chain.

For a list of possible message types returned by this function, see Section 6.9, Result Message Types.

See Also

ldap_msgid, ldap_msgtype