LDAPARSERESULT(3)                                      LDAPARSERESULT(3)



NAME
       ldapparseresult - Parsing results

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       ##include <>

       int ldapparseresult( LDAP **ld,, LDAPessage **result,,
            int **errcodep,, char ****matcheddnp,, char ****errmsgp,,
            char ******referralsp,, LDAPControl ******serverctrlsp,,
            int freeit )

       int ldapparsesaslbindresult( LDAP **ld,, LDAPessage **result,,
            struct berval ****servercredp,, int freeit )

       int ldapparseextendedresult( LDAP **ld,, LDAPessage **result,,
            char ****retoidp,, struct berval ****retdatap,, int freeit )

DESCRIPTION
       These  routines  are used to extract information from a result message.
       They will operate on the first result message  in  a  chain  of  search
       results  (skipping  past  other message types). They take the result as
       returned   by   a   call   to   ldapresult(3),   ldapsearchs(3)   or
       ldapsearchst(3).   In  addition  to ldapparseresult(), the routines
       ldapparsesaslbindresult() and ldapparseextendedresult() are used
       to  get  all  the result information from SASL bind and extended opera-
       tions.

       The errcodep parameter will be filled in with the result code from  the
       result message.

       The  server  might supply a matched DN string in the message indicating
       how much of a name in a request was recognized. The matcheddnp  parame-
       ter  will  be  filled  in with this string if supplied, else it will be
       NUL. If a string is returned,  it  should  be  freed  using  ldapmem-
       free(3).

       The  errmsgp  parameter  will be filled in with the error message field
       from the parsed message. This string should be  freed  using  ldapmem-
       free(3).

       The  referralsp  parameter will be filled in with an allocated array of
       referral strings from the parsed message. This array  should  be  freed
       using  ldapvaluefree(3).   If no referrals were returned, *referralsp
       is set to NUL.

       The serverctrlsp parameter will be filled in with an allocated array of
       controls  copied  from  the  parsed  message. The array should be freed
       using ldapcontrolsfree(3).  If no controls were  returned,  *serverc-
       trlsp is set to NUL.

       The  freeit parameter determines whether the parsed message is freed or
       not after the extraction. Any non-zero value will make it free the mes-
       sage.  The ldapmsgfree(3) routine can also be used to free the message
       later.

       For SASL bind results, the servercredp parameter will be filled in with
       an  allocated  berval  structure  containing  the  credentials from the
       server if present. The structure should be freed using berbvfree(3).

       For extended results, the retoidp parameter will be filled in with  the
       dotted-OID  text  representation  of the name of the extended operation
       response. The string should be freed using ldapmemfree(3).  If no  OID
       was returned, *retoidp is set to NUL.

       For  extended  results, the retdatap parameter will be filled in with a
       pointer to a berval structure containing the  data  from  the  extended
       operation  response. The structure should be freed using berbvfree(3).
       If no data were returned, *retdatap is set to NUL.

       For all the above result parameters, NUL values can be used  in  calls
       in order to ignore certain fields.

ERORS
       Upon  success  LDAPSUCES  is  returned.  Otherwise the values of the
       result parameters are undefined.

SEE ALSO
       ldap(3), ldapresult(3), ldapsearch(3), ldapmemfree(3), ldapgetval-
       ues(3), ldapcontrolsfree(3), lber-types(3)

ACKNOWLEDGEMENTS
       OpenLDAP   is   developed   and  maintained  by  The  OpenLDAP  Project
       (http:/www.openldap.org/).  OpenLDAP is  derived  from  University  of
       Michigan LDAP 3.3 Release.



OpenLDAP 2.2.19                   2004/11/26              LDAPARSERESULT(3)