xref: /illumos-gate/usr/src/man/man3ldap/ldap_parse_result.3ldap (revision 87c723434df4be9c0f7ef119567cb6e2da776a36)
te
Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
LDAP_PARSE_RESULT 3LDAP "Jan 27, 2002"
NAME
ldap_parse_result, ldap_parse_extended_result, ldap_parse_sasl_bind_result - LDAP message result parser
SYNOPSIS

cc[ flag... ] file... -lldap[ library... ]
#include <lber.h>
#include <ldap.h>

int ldap_parse_result(LDAP *ld, LDAPMessage *res, int *errcodep,
 char **matcheddnp,char **errmsgp, char ***referralsp,
 LDAPControl ***serverctrlsp,int freeit);

int ldap_parse_sasl_bind_result(LDAP *ld, LDAPMessage *res,
 struct berval**servercredp,int freeit);

int ldap_parse_extended_result(LDAP *ld, LDAPMessage *res,
 struct bervalchar **resultoidp, **resultdata, int freeit);
DESCRIPTION

The ldap_parse_extended_result(), ldap_parse_result() and ldap_parse_sasl_bind_result() routines search for a message to parse. These functions skip messages of type LDAP_RES_SEARCH_ENTRY and LDAP_RES_SEARCH_REFERENCE.

RETURN VALUES

They return LDAP_SUCCESS if the result was successfully parsed or an LDAP error code if not (see ldap_error(3LDAP)).

ATTRIBUTES

See attributes(5) for a description of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
SEE ALSO

ldap_error(3LDAP), ldap_result(3LDAP), attributes(5)