ldap_get_digest_md5_realms

Allows the application to retrieve the realm values returned by the server in the digest-challenge from the DIGEST-MD5 context created by a call to ldap_bind_digest_md5_start.

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_get_digest_md5_realms (
     LDAP_DIGEST_MD5_CONTEXT   *digestMD5ctx,
     char***                   *realms
  );

Parameters

digestMD5ctx

(IN) The DIGEST-MD5 context created by a call to ldap_bind_digest_md5_begin_s.

realms

(IN) A pointer to an array of char pointers. This argument will be set to point to an array of char pointers that point to the realm values. The end of the array is indicated by a NULL element value.

Return Values

0x00

LDAP_SUCCESS

Non-zero

Failure. For a complete list, see LDAP Return Codes.

Remarks

This function allocates memory for the realms array. This memory is freed by calling ldap_bind_digest_md5_finish. The application should NOT attempt to free this memory directly. Multiple calls to the ldap_get_digest_md5_realms function using the same digest-md5 context will return a pointer to the same array allocated by the first call. This function must not be called after a call to ldap_bind_digest_md5_finish for the same digest-md5 context.

See Also

ldap_bind_digest_md5_start, ldap_bind_digest_md5_finish